Add UBN account - Leap Financial Documentation

Authorizations

api_key

string

header

required

Path Parameters

userToken

string

required

User token.

Body

application/json

Validated payload with required parameters.

Add a UBN (Uniform Bank Number-style account) as a receiving method in partner funding flows.

number

string

required

UBN number

isPrimary

boolean

Is primary UBN?

currency

string

Currency ISO 4217 format

country

string

Country ISO 3166-1 alpha-2 format

bankName

string

Bank name

Response

200 — OK. UBN added.

Scenarios for this response:

Scenario	How to reproduce	Typical `code` / body
Valid UBN	Valid user + subscriber + accepted UBN.	`AddPaymentMethodResponse`

See also Full scenario matrix.

string

required

Payment method ID

Example: pm_1234567890.

status

enum<string>

required

Payment method status

Available options:

Created,

Validated,

Blocked,

Validating,

Removed,

Disconnected,

ValidationNotApproved,

ValidatedPull,

ValidatedPush,

ValidatedPullAndPush

userId

string

name

string

Payment method name

Example: VISA-1234.

type

string

Payment method type

Example: DebitCard, CreditCard.

isPrimary

boolean

Is primary payment method?

Example: true for primary payment method, false for secondary payment method.

createdAt

string

Created at

Example: 2021-01-01T00:00:00Z.

updatedAt

string

Updated at

Example: 2021-01-01T00:00:00Z.

country

string

Country code

ISO 3166-1 alpha-2 format. Example: US for United States, MX for Mexico.

currency

string

Currency code

ISO 4217 format. Example: USD for United States Dollar, MXN for Mexican Peso.

latitude

number<double>

Address latitude

Example: 37.774929.

longitude

number<double>

Address longitude

Example: -122.419416.

cardType

string

Card type

Example: DebitCard, CreditCard.

number

string

nameOnCard

string

Card holder name

Example: John Doe.

expirationDate

string

Card expiration date

Example: 0631.

expirationYear

string

Card expiration year

Example: 31.

expirationMonth

string

Card expiration month

Example: 06.

securityCode

string

Tokenized Card CVV/CVC code by VGS.

Example: tok_sandbox_brucMoj9eTJR3xhqdmM4AQ.

tokenData

string

cardNetwork

string

Card network

Example: Visa, MasterCard, American Express, Discover, Diners Club, JCB, UnionPay, Maestro, Mir, Verve, Troy, UATP.

allowPullCrossBorder

boolean

If Credit/Debit Card allows pull cross border.

allowPullDomestic

boolean

If Credit/Debit Card allows pull domestic.

allowPushCrossBorder

boolean

If Credit/Debit Card allows push cross border.

allowPushDomestic

boolean

If Credit/Debit Card allows push domestic.

allowReviewAddress

boolean

If Credit/Debit Card allows review address.

requiresBalanceValidation

boolean

accountId

string

Account ID associated with the payment method.

bankEntityNumber

string

Bank entity number

externalId

string

External ID associated with the payment method.

errorValidation

string