Skip to main content
POST

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Path Parameters

openBankingPaymentId
string
required

The ID of the open banking payment to settle.

Body

application/json
status
enum<string>
default:COMPLETED

The outcome to simulate. COMPLETED credits the internal account with the payment's amount; FAILED moves no funds.

Available options:
COMPLETED,
FAILED

Response

The settled open banking payment.

id
string
required

System-generated unique identifier for the open banking payment.

Example:

"OpenBankingPayment:019542f5-b3e7-1d02-0000-000000000020"

internalAccountId
string
required

The EUR internal account the payment funds.

Example:

"InternalAccount:019542f5-b3e7-1d02-0000-000000000005"

customerId
string
required

The customer who owns the internal account and pays from their own bank.

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

status
enum<string>
required
Available options:
PENDING,
COMPLETED,
FAILED,
EXPIRED
amount
object
required

The amount requested from the customer's bank, in EUR.

authorizationUrl
string<uri>
required

Send the customer here to choose their bank and approve the payment. Open it in the customer's browser or a web view rather than an iframe, since many banks hand off to their own app to approve. In sandbox it opens a Grid page that simulates the bank.

Example:

"https://pay.example-provider.com/consent/7f3a9c1e"

redirectUrl
string<uri>
required

The page the customer returns to, as sent on create.

Example:

"https://app.example.com/top-up/return"

reference
string
required

The payment reference the customer's bank sends with the funds, set by Grid. It appears on the customer's bank statement.

Example:

"GRIDOB7F3A9C1E"

expiresAt
string<date-time>
required

The deadline for the customer to approve the payment, after which authorizationUrl stops working. A payment the customer has not approved by then becomes EXPIRED. One approved in time stays PENDING until the bank sends the funds or refuses them.

Example:

"2026-11-19T15:02:00Z"

createdAt
string<date-time>
required

When the payment was created.

Example:

"2026-11-19T14:47:00Z"

updatedAt
string<date-time>
required

When the payment last changed.

Example:

"2026-11-19T14:47:00Z"

incomingTransactionId
string

The incoming transaction that credited the internal account. Set once the credit arrives, which can be shortly after the payment becomes COMPLETED.

Example:

"Transaction:019542f5-b3e7-1d02-0000-000000000021"

failureReason
string

Why the payment did not complete, when Grid knows. Set only when status is FAILED.

Example:

"The customer cancelled the payment at their bank."