Skip to main content
POST
Fund an EUR account by open banking

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A unique identifier for the request. If the same key is sent multiple times, the server will return the same response as the first request.

Maximum string length: 255
Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

id
string
required

The ID of the EUR internal account to fund.

Body

application/json
amount
integer<int64>
required

Amount to pull from the customer's bank, in euro cents.

Example:

25000

redirectUrl
string<uri>
required

The https page the customer returns to after leaving their bank. Grid adds an openBankingPaymentId query parameter naming this payment and keeps any query parameters already present. Reaching this page does not mean the payment succeeded: read the outcome from the OPEN_BANKING_PAYMENT webhook or GET the payment. Ignore any other query parameters added on the way back.

Maximum string length: 1024
Pattern: ^https://
Example:

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

Response

The Idempotency-Key was already used to create this payment. The payment created by the first request is returned.

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."