/api/v1/user/bind-bank-account

post

https://openapitest.osl-pay.com/api/v1/user/bind-bank-account

This API is used to bind a user’s bank account for BankTransfers. It is required when performing BankTransfers withdrawals and is also used in partial refund scenarios.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

userId

number

Unique user ID in OSL Pay

merchantUserId

string

Unique user ID on the merchant side

accountName

string

required

Account holder’s name

sortCode

string

required

Must be 6 digits in the format XX-XX-XX (e.g., 12-34-56).
First 2 digits: Bank identifier
Middle 2 digits: Branch
Last 2 digits: Sub-branch

bankName

string

Name of the user's withdrawal bank
Mandatory when using IBAN + USD

accountNumber

string

accountNumber + sortCode combination is specific to the UK/Ireland banking system for the specific currency being processed, such as GBP, BRL, VND, PLN, etc.

payWayCode

string

Payment method

fiatCurrency

string

Fiat currency

iban

string

iban + bic are used for SWIFT system transfers (e.g., EUR, USD)
Mandatory for KS

bic

string

Bank Identifier Code (also known as SWIFT Code).
8 or 11 alphanumeric characters.
Mandatory for KS

city

string

Mandatory when using IBAN + USD

country

string

Mandatory when payWayCode = IBAN
ISO 3166-1 alpha-3

bankCity

string

Mandatory when using IBAN + USD

bankCountry

string

Mandatory when using IBAN + USD
ISO 3166-1 alpha-3

branch

string

The specific branch of the bank

Headers

appId

string

required

Unique appId assigned to the merchant

timestamp

string

required

Request timestamp

signature

string

required

Signature for the request header

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success response