post

/payments/beneficiaries

A beneficiary is the term given to the recipient of a payment made by OFX. All Beneficiaries are stored securely in our DB.

Authorization

oauth2 - clientCredentials

Request Body

Schema
object
name
string

Name

required
currency
string

Currency

required
alias
string

Alias

email
string

Email

classification
string

Classification

1 validation + required
paymentReason
string

PaymentReason

required
beneficiaryBankDetails
object

BeneficiaryBankDetails

required
beneficiaryAddress
object

BeneficiaryAddress

required
benBizNumber
string

BenBizNumber

Responses

Beneficiary was added successfully

Schema
object
beneficiaryId
string

The identifier for beneficiary object

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
oauth_access_token