Skip to content

Payout service APIs (1.0.0)

Payout service APIs

Overview
E-mail

kjakkula@ripple.com

License

Apache 2.0

Terms of Service

Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/

Forex

Operations

Payout Partner

Operations

Payout Method

Operations

Data requirements

Operations

Payouts

Operations

Get a paginated response of all payouts optionally filtering on partner name and payout status

Request

Returns the paginated response of all payouts

Security
oauth2
Query
partner_namestring
payout_statusstring

a single transaction status or a comma separated list of transaction states

ripplenet_payment_idstring(uuid)

ripplenet_payment_id of the associated transaction

pageinteger
Default 0
sizeinteger
Default 10
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payouts?partner_name=string&payout_status=string&ripplenet_payment_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page=0&size=10' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns a paginated response of all payouts

Bodyapplication/json
contentArray of objectsrequired
payout_partner_idstring(uuid)

The id of the payout partner

payout_method_idstring(uuid)

The id of the payout method

transaction_idstring(uuid)required

The id of the transaction

external_transaction_idstring

The external id of the transaction at the venue.

external_request_idstring

The external id of the request to execute the withdrawal. Ex. ODL_PAYMENT_ID or PRISMA_REQUEST_ID

ripplenet_payment_idstring(uuid)

ripplenet_payment_id of the associated transaction

payout_statusstringrequired
Enum"NOT_STARTED""RETRYABLE""PROCESSING""DELIVERED""DELIVERY_FAILED""NO_INFORMATION_AVAILABLE"
created_atstring(date-time)

Date and time at which the request for payout was created, as an ISO-8601 timestamp in UTC.

payout_detailsobject

The object that holds details of the payout including source/destination currency, beneficiary amount

Example: {"beneficiary_currency":"PHP","sender_amount":234567.89,"sender_currency":"USD","fx_rate":1.47289,"beneficiary_amount":234567.89}
sender_currencystring^[A-Z]{3,4}$

The sender/source currency

Example: "USD"
beneficiary_currencystring^[A-Z]{3,4}$

The beneficiary/destination currency

Example: "PHP"
sender_amountnumber

The optional amount in sender's currency

Example: 234567.89
beneficiary_amountnumber

The amount in beneficiary's currency

Example: 234567.89
fee_amountnumber

The fee charged for this transaction

Example: 2.5
fee_currencystring

The fee currency

Example: "PHP"
fx_ratenumber

The forex currency rate used in the transaction

Example: 1.47289
errorsArray of objects

A list of payout errors

categorystringrequired
Enum"TRANSACTION""VALIDATION""AUTHZ""INTERNAL""MISCELLANEOUS""FUND""ACCOUNT""COMPLIANCE"
titlestringrequired
codestringrequired
detailstringrequired
pageobjectrequired

Common object for holding page details

sizeintegerrequired
total_elementsinteger(int64)required
total_pagesintegerrequired
numberintegerrequired
Response
application/json
{
  "content": [
    { … }
  ],
  "page": {
    "size": 0,
    "total_elements": 0,
    "total_pages": 0,
    "number": 0
  }
}

Create a new payout request

Request

Returns the id and status of the created transaction, along with the payout partner and method id

Security
oauth2
Bodyapplication/jsonrequired
payout_payment_idstring(uuid)required

The id of the payment

payout_method_idstring(uuid)required

The id of the payout method to use

payout_instructionsobjectrequired
PmtIdobject

Set of elements used to reference a payment instruction.

InstrIdstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.

EndToEndIdstring<= 35 characters

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

TxIdstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.

UETRstring<= 36 characters^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

Unique End-to-end Transaction Reference, generated by the Payer and passed through, without modification by the payment participants through to the beneficiary.

ClrSysRefstring<= 35 characters

Unique reference, as assigned by a clearing system, to unambiguously identify the instruction.

IntrBkSttlmAmtobject

ISO20022 pacs.008.001.11 FIToFICustomerCreditTransferV11 field - Amount of money moved between the instructing agent and the instructed agent.

Amountnumberrequired

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217

Ccystring^[A-Z]{3,}$required

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

InstdAmtobject

ISO20022 pacs.008.001.11 FIToFICustomerCreditTransferV11 field - Amount of money moved between the instructing agent and the instructed agent.

Amountnumberrequired

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217

Ccystring^[A-Z]{3,}$required

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Cdtrobject

Party to which an amount of money is due.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CdtrAcctobject

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Idobjectrequired

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

ClrSysobject

Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.

Prtrystring<= 35 characters

Clearing system identification in a proprietary form.

PmtTpInfobject

Set of elements used to further specify the type of transaction.

InstrPrtystring

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. List based on ISO20022 Priority2Code List

Enum"HIGH""NORM"
ClrChanlstring

List based on ISO20022 ClearingChannel2Code List

Enum"RTGS""RTNS""MPNS""BOOK"
CtgyPurpobject

Specifies the high level purpose of the instruction based on a set of pre-defined categories.

Prtrystring<= 35 characters

Field to support proprietary value

Cdstring

List based on ISO20022 ExternalCategoryPurpose1Code List

Enum"BONU""CASH""CBLK""CCRD""CORT""DCRD""DIVI""DVPM""EPAY""FCIN"
SvcLvlobject

Agreement under which or rules under which the transaction should be processed.

Cdstring

List based on ISO20022 List ExternalServiceLevel1Code

Enum"BKTR""NPCA""NUGP""NURG""PRPT""SDVA""SEPA""SVDE""URGP""URNS"
Prtrystring<= 35 characters

Field to support proprietary value

LclInstrmobject

User community specific instrument.

Cdstring

List based on ISO20022 List ExternalLocalInstrument1Code

Enum"DDMC""DDMP""DDMU""TRF""82""83""CPP""RTR""GST""DDT"
Prtrystring<= 35 characters

Field to support proprietary value

ChrgBrstring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. Use ISO ChargeBearerType1Code list, supported values are CRED, DEBT & SHAR.

Enum"DEBT""CRED""SHAR"
UltmtDbtrobject

Ultimate party that owes an amount of money to the (ultimate) creditor.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

InitgPtyobject

Party that initiates the payment.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Dbtrobject

Party that owes an amount of money to the (ultimate) creditor.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

DbtrAcctobject

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

DbtrAgtobject

Financial institution servicing an account for the debtor.

FinInstnIdobject

Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

BICFIstring^([a-zA-Z0-9_-]){8,11}$

Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

ClrSysMmbIdobject

Information used to identify a member within a clearing system.

PstlAdrobject
Othrobject

Unique identification of an agent, as assigned by an institution, using an identification scheme.

BrnchIdobject

Identifies a specific branch of a financial institution.

Idstring<= 35 characters

Unique and unambiguous identification of a branch of a financial institution.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
DbtrAgtAcctobject

Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Prxyobject

Specifies an alternate assumed name for the identification of the account.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

Tpobject

Nature or use of the account.

CdtrAgtobject

Financial institution servicing an account for the creditor.

FinInstnIdobject

Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

BICFIstring^([a-zA-Z0-9_-]){8,11}$

Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

ClrSysMmbIdobject

Information used to identify a member within a clearing system.

PstlAdrobject
Othrobject

Unique identification of an agent, as assigned by an institution, using an identification scheme.

BrnchIdobject

Identifies a specific branch of a financial institution.

Idstring<= 35 characters

Unique and unambiguous identification of a branch of a financial institution.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
UltmtCdtrobject

Ultimate party to which an amount of money is due.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

InstForCdtrAgtobject

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

Cdstring

List based on ISO20022 Instruction3Code List

Enum"CHQB""HOLD""PHOB""TELB"
InstrInfstring<= 140 characters

Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.

Purpobject

Underlying reason for the payment transaction.

Cdstring

Underlying reason for the payment transaction, as published in an external purpose code list. Based on ISO20022 ExternalPurpose1Code List

Enum"BKDF""BKFE""BKFM""BKIP""BKPP""CBLK""CDCB""CDCD""CDCS""CDDP"
Prtrystring<= 35 characters

Field to support proprietary value

RgltryRptgobject

Information needed due to regulatory and statutory requirements.

DbtCdtRptgIndstring

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.

Enum"CRED""DEBT""BOTH"
Authrtyobject

Entity requiring the regulatory reporting information.

Nmstring<= 140 characters

Name of the entity requiring the regulatory reporting information.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Dtlsobject

Set of elements used to provide details on the regulatory reporting information.

Tpstring<= 35 characters

Specifies the type of the information supplied in the regulatory reporting details.

Dtstring(date-time)

Date related to the specified type of regulatory reporting details.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Cdstring<= 10 characters

Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.

Amtobject

Amount of money to be reported for regulatory and statutory requirements.

Infstring<= 35 characters

Additional details that cater for specific domestic regulatory requirements.

RltdRmtInfobject

Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.

RmtIdstring<= 35 characters

Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice.

RmtLctnDtlsobject

Set of elements used to provide information on the location and/or delivery of the remittance information.

Mtdstring

List based on ISO 20022 RemittanceLocationMethod2Code List

Enum"FAXI""EDIC""URID""EMAL""POST""SMSM"
ElctrncAdrstring<= 2048 characters

Electronic address to which an agent is to send the remittance information.

PstlAdrobject

Postal address to which an agent is to send the remittance information.

RmtInfobject

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Ustrdstring<= 140 characters

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. Please note, should new lines be required in this field, should be used to denote a new line.

Strdobject

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.

RfrdDocInfobject

Provides the identification and the content of the referred document.

RfrdDocAmtobject

Provides details on the amounts of the referred document.

CdtrRefInfobject

Reference information provided by the creditor to allow the identification of the underlying documents.

Invcrobject

Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor.

Invceeobject

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

TaxRmtobject

Provides remittance information about a payment made for tax-related purposes.

GrnshmtRmtobject

Provides remittance information about a payment for garnishment-related purposes.

AddtlRmtInfArray of arrays

Additional information, in the form of an array of strings, to complement the structured remittance information. Maximum of 4 lines to ensure consistency with the ISO20022 specification.

original_message_pacs008string

Provides the ability to include the original PACS.008 message

original_message_mt103string

Provides the ability to include the original MT103 message

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payouts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payout_payment_id": "b22dc334-d1d3-4646-a89e-3e6d455f404a",
    "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
    "payout_instructions": {
      "PmtId": {
        "InstrId": "string",
        "EndToEndId": "string",
        "TxId": "string",
        "UETR": "string",
        "ClrSysRef": "string"
      },
      "IntrBkSttlmAmt": {
        "Amount": 0,
        "Ccy": "string"
      },
      "InstdAmt": {
        "Amount": 0,
        "Ccy": "string"
      },
      "Cdtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "CdtrAcct": {
        "Nm": "string",
        "Ccy": "string",
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        }
      },
      "ClrSys": {
        "Prtry": "string"
      },
      "PmtTpInf": {
        "InstrPrty": "HIGH",
        "ClrChanl": "RTGS",
        "CtgyPurp": {
          "Prtry": "string",
          "Cd": "BONU"
        },
        "SvcLvl": {
          "Cd": "BKTR",
          "Prtry": "string"
        },
        "LclInstrm": {
          "Cd": "DDMC",
          "Prtry": "string"
        }
      },
      "ChrgBr": "DEBT",
      "UltmtDbtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "InitgPty": {
        "Nm": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        },
        "CtryOfRes": "string",
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        }
      },
      "Dbtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        }
      },
      "DbtrAcct": {
        "Nm": "string",
        "Ccy": "string",
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        }
      },
      "DbtrAgt": {
        "FinInstnId": {
          "BICFI": "string",
          "Nm": "string",
          "ClrSysMmbId": {
            "MmbId": "string",
            "ClrSysId": {
              "Cd": "ATBLZ",
              "Prtry": "string"
            }
          },
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          },
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "string",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "BrnchId": {
          "Id": "string",
          "Nm": "string",
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          }
        }
      },
      "DbtrAgtAcct": {
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        },
        "Ccy": "string",
        "Nm": "string",
        "Prxy": {
          "Id": {
            "IBAN": "string",
            "Othr": {
              "Id": "string",
              "SchmeNm": {
                "Cd": "AIIN",
                "Prtry": "string"
              },
              "Issr": "string"
            }
          },
          "Tp": {
            "Cd": "CACC",
            "Prtry": "string"
          }
        }
      },
      "CdtrAgt": {
        "FinInstnId": {
          "BICFI": "string",
          "Nm": "string",
          "ClrSysMmbId": {
            "MmbId": "string",
            "ClrSysId": {
              "Cd": "ATBLZ",
              "Prtry": "string"
            }
          },
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          },
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "string",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "BrnchId": {
          "Id": "string",
          "Nm": "string",
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          }
        }
      },
      "UltmtCdtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "InstForCdtrAgt": {
        "Cd": "CHQB",
        "InstrInf": "string"
      },
      "Purp": {
        "Cd": "BKDF",
        "Prtry": "string"
      },
      "RgltryRptg": {
        "DbtCdtRptgInd": "CRED",
        "Authrty": {
          "Nm": "string",
          "Ctry": "string"
        },
        "Dtls": {
          "Tp": "string",
          "Dt": "2019-08-24T14:15:22Z",
          "Ctry": "string",
          "Cd": "string",
          "Amt": {
            "amount": "string",
            "Ccy": "string"
          },
          "Inf": "string"
        }
      },
      "RltdRmtInf": {
        "RmtId": "string",
        "RmtLctnDtls": {
          "Mtd": "FAXI",
          "ElctrncAdr": "string",
          "PstlAdr": {
            "Nm": "string",
            "Adr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            }
          }
        }
      },
      "RmtInf": {
        "Ustrd": "string",
        "Strd": {
          "RfrdDocInf": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "MSIN",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Nb": "string",
            "RltdDt": "2019-08-24T14:15:22Z",
            "LineDtls": []
          },
          "RfrdDocAmt": {
            "DuePyblAmt": {
              "amount": "string",
              "currency": "string"
            },
            "DscntApldAmt": {
              "Tp": {
                "Cd": "APDS",
                "Prtry": "string"
              },
              "Amt": {
                "amount": "string",
                "currency": "string"
              }
            },
            "CdtNoteAmt": {
              "amount": "string",
              "currency": "string"
            },
            "TaxAmt": {
              "Tp": {
                "Cd": "CITY",
                "Prtry": "string"
              },
              "Amt": {
                "amount": "string",
                "currency": "string"
              }
            },
            "AdjstmntAmtAndRsn": {
              "Amt": {
                "amount": "string",
                "currency": "string"
              },
              "CdtDbtInd": "CRDT",
              "Rsn": "stri",
              "AddtlInf": "string"
            },
            "RmtdAmt": {
              "amount": "string",
              "currency": "string"
            }
          },
          "CdtrRefInf": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "RADM",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Ref": "string"
          },
          "Invcr": {
            "Nm": "string",
            "StrdNm": {
              "FirstNm": "string",
              "MidNm": "string",
              "LastNm": "string",
              "LastNm2": "string",
              "NtrlNm": "string",
              "Title": "string"
            },
            "CtryOfRes": "string",
            "PstlAdr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            },
            "Id": {
              "OrgId": {
                "AnyBIC": "string",
                "DtAndPlcofIncorprtn": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "RelShipToDbtr": "BRAN",
                "RelShipToCdtr": "BRAN",
                "Rprtv": {
                  "StrdNm": {}
                }
              },
              "PrvtId": {
                "DtAndPlcOfBirth": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "Gender": "string",
                "Profession": "string",
                "RelShipToDbtr": "CHIL",
                "Ntlty": "str",
                "Residence": "str",
                "Citizenship": {}
              }
            },
            "CtctDtls": {
              "CtctDtls": {
                "NmPrfx": "DOCT",
                "Nm": "string",
                "PhneNb": "string",
                "MobNb": "string",
                "FaxNb": "string",
                "EmailAdr": "string",
                "Othr": "string"
              }
            }
          },
          "Invcee": {
            "Nm": "string",
            "StrdNm": {
              "FirstNm": "string",
              "MidNm": "string",
              "LastNm": "string",
              "LastNm2": "string",
              "NtrlNm": "string",
              "Title": "string"
            },
            "CtryOfRes": "string",
            "PstlAdr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            },
            "Id": {
              "OrgId": {
                "AnyBIC": "string",
                "DtAndPlcofIncorprtn": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "RelShipToDbtr": "BRAN",
                "RelShipToCdtr": "BRAN",
                "Rprtv": {
                  "StrdNm": {}
                }
              },
              "PrvtId": {
                "DtAndPlcOfBirth": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "Gender": "string",
                "Profession": "string",
                "RelShipToDbtr": "CHIL",
                "Ntlty": "str",
                "Residence": "str",
                "Citizenship": {}
              }
            },
            "CtctDtls": {
              "CtctDtls": {
                "NmPrfx": "DOCT",
                "Nm": "string",
                "PhneNb": "string",
                "MobNb": "string",
                "FaxNb": "string",
                "EmailAdr": "string",
                "Othr": "string"
              }
            }
          },
          "TaxRmt": {
            "Cdtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string"
            },
            "Dbtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string",
              "Authstn": {
                "Titl": "string",
                "Nm": "string"
              }
            },
            "UltmtDbtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string",
              "Authstn": {
                "Titl": "string",
                "Nm": "string"
              }
            },
            "AdmstnZone": "string",
            "RefNb": "string",
            "Mtd": "string",
            "TtlTaxblBaseAmt": {
              "amount": "string",
              "currency": "string"
            },
            "TtlTaxAmt": {
              "amount": "string",
              "currency": "string"
            },
            "Dt": "2019-08-24T14:15:22Z",
            "SeqNb": 0,
            "Rcrd": {
              "Tp": "string",
              "Ctgy": "string",
              "CtgyDtls": "string",
              "DbtrSts": "string",
              "CertId": "string",
              "FrmsCd": "string",
              "Prd": {
                "Yr": "2019-08-24T14:15:22Z",
                "Tp": "MM01",
                "FrToDt": {}
              },
              "TaxAmt": {
                "Rate": 100,
                "TtlTaxblBaseAmt": {},
                "TtlAmt": {},
                "Dtls": {
                  "Prd": {},
                  "Amt": {}
                },
                "AddtlInf": "string"
              }
            }
          },
          "GrnshmtRmt": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "GNCS",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Grnshee": {
              "Nm": "string",
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              },
              "CtryOfRes": "string",
              "PstlAdr": {
                "AdrTp": "ADDR",
                "AdrLine": [
                  null
                ],
                "Dept": "string",
                "SubDept": "string",
                "StrtNm": "string",
                "BldgNb": "string",
                "PstCd": "string",
                "TwnNm": "string",
                "CtrySubDvsn": "string",
                "Ctry": "string"
              },
              "Id": {
                "OrgId": {
                  "DtAndPlcofIncorprtn": {},
                  "Othr": {},
                  "Rprtv": {}
                },
                "PrvtId": {
                  "DtAndPlcOfBirth": {},
                  "Othr": {},
                  "Citizenship": {}
                }
              },
              "CtctDtls": {
                "CtctDtls": {}
              }
            },
            "GrnshmyAdmstr": {
              "Nm": "string",
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              },
              "CtryOfRes": "string",
              "PstlAdr": {
                "AdrTp": "ADDR",
                "AdrLine": [
                  null
                ],
                "Dept": "string",
                "SubDept": "string",
                "StrtNm": "string",
                "BldgNb": "string",
                "PstCd": "string",
                "TwnNm": "string",
                "CtrySubDvsn": "string",
                "Ctry": "string"
              },
              "Id": {
                "OrgId": {
                  "DtAndPlcofIncorprtn": {},
                  "Othr": {},
                  "Rprtv": {}
                },
                "PrvtId": {
                  "DtAndPlcOfBirth": {},
                  "Othr": {},
                  "Citizenship": {}
                }
              },
              "CtctDtls": {
                "CtctDtls": {}
              }
            },
            "RefNb": "string",
            "Dt": "2019-08-24T14:15:22Z",
            "RmtdAmt": {
              "amount": "string",
              "currency": "string"
            },
            "FmlyMdcllnsrncInd": true,
            "MplyeeTermntnInd": true
          },
          "AddtlRmtInf": []
        }
      },
      "original_message_pacs008": "string",
      "original_message_mt103": "string"
    }
  }'

Responses

Returns details about the created payout

Bodyapplication/json
payout_partner_idstring(uuid)

The id of the payout partner

payout_method_idstring(uuid)

The id of the payout method

transaction_idstring(uuid)required

The id of the transaction

external_transaction_idstring

The external id of the transaction at the venue.

external_request_idstring

The external id of the request to execute the withdrawal. Ex. ODL_PAYMENT_ID or PRISMA_REQUEST_ID

ripplenet_payment_idstring(uuid)

ripplenet_payment_id of the associated transaction

payout_statusstringrequired
Enum"NOT_STARTED""RETRYABLE""PROCESSING""DELIVERED""DELIVERY_FAILED""NO_INFORMATION_AVAILABLE"
created_atstring(date-time)

Date and time at which the request for payout was created, as an ISO-8601 timestamp in UTC.

payout_detailsobject

The object that holds details of the payout including source/destination currency, beneficiary amount

Example: {"beneficiary_currency":"PHP","sender_amount":234567.89,"sender_currency":"USD","fx_rate":1.47289,"beneficiary_amount":234567.89}
sender_currencystring^[A-Z]{3,4}$

The sender/source currency

Example: "USD"
beneficiary_currencystring^[A-Z]{3,4}$

The beneficiary/destination currency

Example: "PHP"
sender_amountnumber

The optional amount in sender's currency

Example: 234567.89
beneficiary_amountnumber

The amount in beneficiary's currency

Example: 234567.89
fee_amountnumber

The fee charged for this transaction

Example: 2.5
fee_currencystring

The fee currency

Example: "PHP"
fx_ratenumber

The forex currency rate used in the transaction

Example: 1.47289
errorsArray of objects

A list of payout errors

categorystringrequired
Enum"TRANSACTION""VALIDATION""AUTHZ""INTERNAL""MISCELLANEOUS""FUND""ACCOUNT""COMPLIANCE"
titlestringrequired
codestringrequired
detailstringrequired
Response
application/json
{
  "payout_partner_id": "65606de6-d86e-468e-8e69-55184fddf40c",
  "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
  "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  "external_transaction_id": "string",
  "external_request_id": "string",
  "ripplenet_payment_id": "7bb2080a-9fd7-4f64-af96-119671501c9c",
  "payout_status": "NOT_STARTED",
  "created_at": "2019-08-24T14:15:22Z",
  "payout_details": {
    "beneficiary_currency": "PHP",
    "sender_amount": 234567.89,
    "sender_currency": "USD",
    "fx_rate": 1.47289,
    "beneficiary_amount": 234567.89
  },
  "errors": [
    { … }
  ]
}

Create a new payout request using RPO user_info fields

Request

Returns the id and status of the created transaction, along with the payout partner and method id

Security
oauth2
Bodyapplication/jsonrequired
payout_payment_idstring(uuid)required

The id of the payment

payout_method_idstring(uuid)required

The id of the payout method to use

payout_instructionsobjectrequired
PmtIdobject

Set of elements used to reference a payment instruction.

InstrIdstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.

EndToEndIdstring<= 35 characters

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

TxIdstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.

UETRstring<= 36 characters^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

Unique End-to-end Transaction Reference, generated by the Payer and passed through, without modification by the payment participants through to the beneficiary.

ClrSysRefstring<= 35 characters

Unique reference, as assigned by a clearing system, to unambiguously identify the instruction.

IntrBkSttlmAmtobject

ISO20022 pacs.008.001.11 FIToFICustomerCreditTransferV11 field - Amount of money moved between the instructing agent and the instructed agent.

Amountnumberrequired

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217

Ccystring^[A-Z]{3,}$required

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

InstdAmtobject

ISO20022 pacs.008.001.11 FIToFICustomerCreditTransferV11 field - Amount of money moved between the instructing agent and the instructed agent.

Amountnumberrequired

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217

Ccystring^[A-Z]{3,}$required

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Cdtrobject

Party to which an amount of money is due.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CdtrAcctobject

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Idobjectrequired

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

ClrSysobject

Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.

Prtrystring<= 35 characters

Clearing system identification in a proprietary form.

PmtTpInfobject

Set of elements used to further specify the type of transaction.

InstrPrtystring

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. List based on ISO20022 Priority2Code List

Enum"HIGH""NORM"
ClrChanlstring

List based on ISO20022 ClearingChannel2Code List

Enum"RTGS""RTNS""MPNS""BOOK"
CtgyPurpobject

Specifies the high level purpose of the instruction based on a set of pre-defined categories.

Prtrystring<= 35 characters

Field to support proprietary value

Cdstring

List based on ISO20022 ExternalCategoryPurpose1Code List

Enum"BONU""CASH""CBLK""CCRD""CORT""DCRD""DIVI""DVPM""EPAY""FCIN"
SvcLvlobject

Agreement under which or rules under which the transaction should be processed.

Cdstring

List based on ISO20022 List ExternalServiceLevel1Code

Enum"BKTR""NPCA""NUGP""NURG""PRPT""SDVA""SEPA""SVDE""URGP""URNS"
Prtrystring<= 35 characters

Field to support proprietary value

LclInstrmobject

User community specific instrument.

Cdstring

List based on ISO20022 List ExternalLocalInstrument1Code

Enum"DDMC""DDMP""DDMU""TRF""82""83""CPP""RTR""GST""DDT"
Prtrystring<= 35 characters

Field to support proprietary value

ChrgBrstring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. Use ISO ChargeBearerType1Code list, supported values are CRED, DEBT & SHAR.

Enum"DEBT""CRED""SHAR"
UltmtDbtrobject

Ultimate party that owes an amount of money to the (ultimate) creditor.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

InitgPtyobject

Party that initiates the payment.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Dbtrobject

Party that owes an amount of money to the (ultimate) creditor.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

DbtrAcctobject

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

DbtrAgtobject

Financial institution servicing an account for the debtor.

FinInstnIdobject

Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

BICFIstring^([a-zA-Z0-9_-]){8,11}$

Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

ClrSysMmbIdobject

Information used to identify a member within a clearing system.

PstlAdrobject
Othrobject

Unique identification of an agent, as assigned by an institution, using an identification scheme.

BrnchIdobject

Identifies a specific branch of a financial institution.

Idstring<= 35 characters

Unique and unambiguous identification of a branch of a financial institution.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
DbtrAgtAcctobject

Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Prxyobject

Specifies an alternate assumed name for the identification of the account.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

Tpobject

Nature or use of the account.

CdtrAgtobject

Financial institution servicing an account for the creditor.

FinInstnIdobject

Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

BICFIstring^([a-zA-Z0-9_-]){8,11}$

Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

ClrSysMmbIdobject

Information used to identify a member within a clearing system.

PstlAdrobject
Othrobject

Unique identification of an agent, as assigned by an institution, using an identification scheme.

BrnchIdobject

Identifies a specific branch of a financial institution.

Idstring<= 35 characters

Unique and unambiguous identification of a branch of a financial institution.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
UltmtCdtrobject

Ultimate party to which an amount of money is due.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

InstForCdtrAgtobject

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

Cdstring

List based on ISO20022 Instruction3Code List

Enum"CHQB""HOLD""PHOB""TELB"
InstrInfstring<= 140 characters

Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.

Purpobject

Underlying reason for the payment transaction.

Cdstring

Underlying reason for the payment transaction, as published in an external purpose code list. Based on ISO20022 ExternalPurpose1Code List

Enum"BKDF""BKFE""BKFM""BKIP""BKPP""CBLK""CDCB""CDCD""CDCS""CDDP"
Prtrystring<= 35 characters

Field to support proprietary value

RgltryRptgobject

Information needed due to regulatory and statutory requirements.

DbtCdtRptgIndstring

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.

Enum"CRED""DEBT""BOTH"
Authrtyobject

Entity requiring the regulatory reporting information.

Nmstring<= 140 characters

Name of the entity requiring the regulatory reporting information.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Dtlsobject

Set of elements used to provide details on the regulatory reporting information.

Tpstring<= 35 characters

Specifies the type of the information supplied in the regulatory reporting details.

Dtstring(date-time)

Date related to the specified type of regulatory reporting details.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Cdstring<= 10 characters

Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.

Amtobject

Amount of money to be reported for regulatory and statutory requirements.

Infstring<= 35 characters

Additional details that cater for specific domestic regulatory requirements.

RltdRmtInfobject

Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.

RmtIdstring<= 35 characters

Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice.

RmtLctnDtlsobject

Set of elements used to provide information on the location and/or delivery of the remittance information.

Mtdstring

List based on ISO 20022 RemittanceLocationMethod2Code List

Enum"FAXI""EDIC""URID""EMAL""POST""SMSM"
ElctrncAdrstring<= 2048 characters

Electronic address to which an agent is to send the remittance information.

PstlAdrobject

Postal address to which an agent is to send the remittance information.

RmtInfobject

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Ustrdstring<= 140 characters

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. Please note, should new lines be required in this field, should be used to denote a new line.

Strdobject

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.

RfrdDocInfobject

Provides the identification and the content of the referred document.

RfrdDocAmtobject

Provides details on the amounts of the referred document.

CdtrRefInfobject

Reference information provided by the creditor to allow the identification of the underlying documents.

Invcrobject

Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor.

Invceeobject

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

TaxRmtobject

Provides remittance information about a payment made for tax-related purposes.

GrnshmtRmtobject

Provides remittance information about a payment for garnishment-related purposes.

AddtlRmtInfArray of arrays

Additional information, in the form of an array of strings, to complement the structured remittance information. Maximum of 4 lines to ensure consistency with the ISO20022 specification.

original_message_pacs008string

Provides the ability to include the original PACS.008 message

original_message_mt103string

Provides the ability to include the original MT103 message

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payouts/rpo \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payout_payment_id": "b22dc334-d1d3-4646-a89e-3e6d455f404a",
    "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
    "payout_instructions": {
      "PmtId": {
        "InstrId": "string",
        "EndToEndId": "string",
        "TxId": "string",
        "UETR": "string",
        "ClrSysRef": "string"
      },
      "IntrBkSttlmAmt": {
        "Amount": 0,
        "Ccy": "string"
      },
      "InstdAmt": {
        "Amount": 0,
        "Ccy": "string"
      },
      "Cdtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "CdtrAcct": {
        "Nm": "string",
        "Ccy": "string",
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        }
      },
      "ClrSys": {
        "Prtry": "string"
      },
      "PmtTpInf": {
        "InstrPrty": "HIGH",
        "ClrChanl": "RTGS",
        "CtgyPurp": {
          "Prtry": "string",
          "Cd": "BONU"
        },
        "SvcLvl": {
          "Cd": "BKTR",
          "Prtry": "string"
        },
        "LclInstrm": {
          "Cd": "DDMC",
          "Prtry": "string"
        }
      },
      "ChrgBr": "DEBT",
      "UltmtDbtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "InitgPty": {
        "Nm": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        },
        "CtryOfRes": "string",
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        }
      },
      "Dbtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        }
      },
      "DbtrAcct": {
        "Nm": "string",
        "Ccy": "string",
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        }
      },
      "DbtrAgt": {
        "FinInstnId": {
          "BICFI": "string",
          "Nm": "string",
          "ClrSysMmbId": {
            "MmbId": "string",
            "ClrSysId": {
              "Cd": "ATBLZ",
              "Prtry": "string"
            }
          },
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          },
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "string",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "BrnchId": {
          "Id": "string",
          "Nm": "string",
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          }
        }
      },
      "DbtrAgtAcct": {
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        },
        "Ccy": "string",
        "Nm": "string",
        "Prxy": {
          "Id": {
            "IBAN": "string",
            "Othr": {
              "Id": "string",
              "SchmeNm": {
                "Cd": "AIIN",
                "Prtry": "string"
              },
              "Issr": "string"
            }
          },
          "Tp": {
            "Cd": "CACC",
            "Prtry": "string"
          }
        }
      },
      "CdtrAgt": {
        "FinInstnId": {
          "BICFI": "string",
          "Nm": "string",
          "ClrSysMmbId": {
            "MmbId": "string",
            "ClrSysId": {
              "Cd": "ATBLZ",
              "Prtry": "string"
            }
          },
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          },
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "string",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "BrnchId": {
          "Id": "string",
          "Nm": "string",
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          }
        }
      },
      "UltmtCdtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "InstForCdtrAgt": {
        "Cd": "CHQB",
        "InstrInf": "string"
      },
      "Purp": {
        "Cd": "BKDF",
        "Prtry": "string"
      },
      "RgltryRptg": {
        "DbtCdtRptgInd": "CRED",
        "Authrty": {
          "Nm": "string",
          "Ctry": "string"
        },
        "Dtls": {
          "Tp": "string",
          "Dt": "2019-08-24T14:15:22Z",
          "Ctry": "string",
          "Cd": "string",
          "Amt": {
            "amount": "string",
            "Ccy": "string"
          },
          "Inf": "string"
        }
      },
      "RltdRmtInf": {
        "RmtId": "string",
        "RmtLctnDtls": {
          "Mtd": "FAXI",
          "ElctrncAdr": "string",
          "PstlAdr": {
            "Nm": "string",
            "Adr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            }
          }
        }
      },
      "RmtInf": {
        "Ustrd": "string",
        "Strd": {
          "RfrdDocInf": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "MSIN",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Nb": "string",
            "RltdDt": "2019-08-24T14:15:22Z",
            "LineDtls": []
          },
          "RfrdDocAmt": {
            "DuePyblAmt": {
              "amount": "string",
              "currency": "string"
            },
            "DscntApldAmt": {
              "Tp": {
                "Cd": "APDS",
                "Prtry": "string"
              },
              "Amt": {
                "amount": "string",
                "currency": "string"
              }
            },
            "CdtNoteAmt": {
              "amount": "string",
              "currency": "string"
            },
            "TaxAmt": {
              "Tp": {
                "Cd": "CITY",
                "Prtry": "string"
              },
              "Amt": {
                "amount": "string",
                "currency": "string"
              }
            },
            "AdjstmntAmtAndRsn": {
              "Amt": {
                "amount": "string",
                "currency": "string"
              },
              "CdtDbtInd": "CRDT",
              "Rsn": "stri",
              "AddtlInf": "string"
            },
            "RmtdAmt": {
              "amount": "string",
              "currency": "string"
            }
          },
          "CdtrRefInf": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "RADM",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Ref": "string"
          },
          "Invcr": {
            "Nm": "string",
            "StrdNm": {
              "FirstNm": "string",
              "MidNm": "string",
              "LastNm": "string",
              "LastNm2": "string",
              "NtrlNm": "string",
              "Title": "string"
            },
            "CtryOfRes": "string",
            "PstlAdr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            },
            "Id": {
              "OrgId": {
                "AnyBIC": "string",
                "DtAndPlcofIncorprtn": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "RelShipToDbtr": "BRAN",
                "RelShipToCdtr": "BRAN",
                "Rprtv": {
                  "StrdNm": {}
                }
              },
              "PrvtId": {
                "DtAndPlcOfBirth": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "Gender": "string",
                "Profession": "string",
                "RelShipToDbtr": "CHIL",
                "Ntlty": "str",
                "Residence": "str",
                "Citizenship": {}
              }
            },
            "CtctDtls": {
              "CtctDtls": {
                "NmPrfx": "DOCT",
                "Nm": "string",
                "PhneNb": "string",
                "MobNb": "string",
                "FaxNb": "string",
                "EmailAdr": "string",
                "Othr": "string"
              }
            }
          },
          "Invcee": {
            "Nm": "string",
            "StrdNm": {
              "FirstNm": "string",
              "MidNm": "string",
              "LastNm": "string",
              "LastNm2": "string",
              "NtrlNm": "string",
              "Title": "string"
            },
            "CtryOfRes": "string",
            "PstlAdr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            },
            "Id": {
              "OrgId": {
                "AnyBIC": "string",
                "DtAndPlcofIncorprtn": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "RelShipToDbtr": "BRAN",
                "RelShipToCdtr": "BRAN",
                "Rprtv": {
                  "StrdNm": {}
                }
              },
              "PrvtId": {
                "DtAndPlcOfBirth": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "Gender": "string",
                "Profession": "string",
                "RelShipToDbtr": "CHIL",
                "Ntlty": "str",
                "Residence": "str",
                "Citizenship": {}
              }
            },
            "CtctDtls": {
              "CtctDtls": {
                "NmPrfx": "DOCT",
                "Nm": "string",
                "PhneNb": "string",
                "MobNb": "string",
                "FaxNb": "string",
                "EmailAdr": "string",
                "Othr": "string"
              }
            }
          },
          "TaxRmt": {
            "Cdtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string"
            },
            "Dbtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string",
              "Authstn": {
                "Titl": "string",
                "Nm": "string"
              }
            },
            "UltmtDbtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string",
              "Authstn": {
                "Titl": "string",
                "Nm": "string"
              }
            },
            "AdmstnZone": "string",
            "RefNb": "string",
            "Mtd": "string",
            "TtlTaxblBaseAmt": {
              "amount": "string",
              "currency": "string"
            },
            "TtlTaxAmt": {
              "amount": "string",
              "currency": "string"
            },
            "Dt": "2019-08-24T14:15:22Z",
            "SeqNb": 0,
            "Rcrd": {
              "Tp": "string",
              "Ctgy": "string",
              "CtgyDtls": "string",
              "DbtrSts": "string",
              "CertId": "string",
              "FrmsCd": "string",
              "Prd": {
                "Yr": "2019-08-24T14:15:22Z",
                "Tp": "MM01",
                "FrToDt": {}
              },
              "TaxAmt": {
                "Rate": 100,
                "TtlTaxblBaseAmt": {},
                "TtlAmt": {},
                "Dtls": {
                  "Prd": {},
                  "Amt": {}
                },
                "AddtlInf": "string"
              }
            }
          },
          "GrnshmtRmt": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "GNCS",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Grnshee": {
              "Nm": "string",
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              },
              "CtryOfRes": "string",
              "PstlAdr": {
                "AdrTp": "ADDR",
                "AdrLine": [
                  null
                ],
                "Dept": "string",
                "SubDept": "string",
                "StrtNm": "string",
                "BldgNb": "string",
                "PstCd": "string",
                "TwnNm": "string",
                "CtrySubDvsn": "string",
                "Ctry": "string"
              },
              "Id": {
                "OrgId": {
                  "DtAndPlcofIncorprtn": {},
                  "Othr": {},
                  "Rprtv": {}
                },
                "PrvtId": {
                  "DtAndPlcOfBirth": {},
                  "Othr": {},
                  "Citizenship": {}
                }
              },
              "CtctDtls": {
                "CtctDtls": {}
              }
            },
            "GrnshmyAdmstr": {
              "Nm": "string",
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              },
              "CtryOfRes": "string",
              "PstlAdr": {
                "AdrTp": "ADDR",
                "AdrLine": [
                  null
                ],
                "Dept": "string",
                "SubDept": "string",
                "StrtNm": "string",
                "BldgNb": "string",
                "PstCd": "string",
                "TwnNm": "string",
                "CtrySubDvsn": "string",
                "Ctry": "string"
              },
              "Id": {
                "OrgId": {
                  "DtAndPlcofIncorprtn": {},
                  "Othr": {},
                  "Rprtv": {}
                },
                "PrvtId": {
                  "DtAndPlcOfBirth": {},
                  "Othr": {},
                  "Citizenship": {}
                }
              },
              "CtctDtls": {
                "CtctDtls": {}
              }
            },
            "RefNb": "string",
            "Dt": "2019-08-24T14:15:22Z",
            "RmtdAmt": {
              "amount": "string",
              "currency": "string"
            },
            "FmlyMdcllnsrncInd": true,
            "MplyeeTermntnInd": true
          },
          "AddtlRmtInf": []
        }
      },
      "original_message_pacs008": "string",
      "original_message_mt103": "string"
    }
  }'

Responses

Returns details about the created payout

Bodyapplication/json
payout_partner_idstring(uuid)

The id of the payout partner

payout_method_idstring(uuid)

The id of the payout method

transaction_idstring(uuid)required

The id of the transaction

external_transaction_idstring

The external id of the transaction at the venue.

external_request_idstring

The external id of the request to execute the withdrawal. Ex. ODL_PAYMENT_ID or PRISMA_REQUEST_ID

ripplenet_payment_idstring(uuid)

ripplenet_payment_id of the associated transaction

payout_statusstringrequired
Enum"NOT_STARTED""RETRYABLE""PROCESSING""DELIVERED""DELIVERY_FAILED""NO_INFORMATION_AVAILABLE"
created_atstring(date-time)

Date and time at which the request for payout was created, as an ISO-8601 timestamp in UTC.

payout_detailsobject

The object that holds details of the payout including source/destination currency, beneficiary amount

Example: {"beneficiary_currency":"PHP","sender_amount":234567.89,"sender_currency":"USD","fx_rate":1.47289,"beneficiary_amount":234567.89}
sender_currencystring^[A-Z]{3,4}$

The sender/source currency

Example: "USD"
beneficiary_currencystring^[A-Z]{3,4}$

The beneficiary/destination currency

Example: "PHP"
sender_amountnumber

The optional amount in sender's currency

Example: 234567.89
beneficiary_amountnumber

The amount in beneficiary's currency

Example: 234567.89
fee_amountnumber

The fee charged for this transaction

Example: 2.5
fee_currencystring

The fee currency

Example: "PHP"
fx_ratenumber

The forex currency rate used in the transaction

Example: 1.47289
errorsArray of objects

A list of payout errors

categorystringrequired
Enum"TRANSACTION""VALIDATION""AUTHZ""INTERNAL""MISCELLANEOUS""FUND""ACCOUNT""COMPLIANCE"
titlestringrequired
codestringrequired
detailstringrequired
Response
application/json
{
  "payout_partner_id": "65606de6-d86e-468e-8e69-55184fddf40c",
  "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
  "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  "external_transaction_id": "string",
  "external_request_id": "string",
  "ripplenet_payment_id": "7bb2080a-9fd7-4f64-af96-119671501c9c",
  "payout_status": "NOT_STARTED",
  "created_at": "2019-08-24T14:15:22Z",
  "payout_details": {
    "beneficiary_currency": "PHP",
    "sender_amount": 234567.89,
    "sender_currency": "USD",
    "fx_rate": 1.47289,
    "beneficiary_amount": 234567.89
  },
  "errors": [
    { … }
  ]
}

Get payout status by transaction id

Request

Returns the payout details including status for the requested transaction_id

Security
oauth2
Path
transaction_idstring(uuid)required
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payouts/{transaction_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the payout status

Bodyapplication/json
payout_partner_idstring(uuid)

The id of the payout partner

payout_method_idstring(uuid)

The id of the payout method

transaction_idstring(uuid)required

The id of the transaction

external_transaction_idstring

The external id of the transaction at the venue.

external_request_idstring

The external id of the request to execute the withdrawal. Ex. ODL_PAYMENT_ID or PRISMA_REQUEST_ID

ripplenet_payment_idstring(uuid)

ripplenet_payment_id of the associated transaction

payout_statusstringrequired
Enum"NOT_STARTED""RETRYABLE""PROCESSING""DELIVERED""DELIVERY_FAILED""NO_INFORMATION_AVAILABLE"
created_atstring(date-time)

Date and time at which the request for payout was created, as an ISO-8601 timestamp in UTC.

payout_detailsobject

The object that holds details of the payout including source/destination currency, beneficiary amount

Example: {"beneficiary_currency":"PHP","sender_amount":234567.89,"sender_currency":"USD","fx_rate":1.47289,"beneficiary_amount":234567.89}
sender_currencystring^[A-Z]{3,4}$

The sender/source currency

Example: "USD"
beneficiary_currencystring^[A-Z]{3,4}$

The beneficiary/destination currency

Example: "PHP"
sender_amountnumber

The optional amount in sender's currency

Example: 234567.89
beneficiary_amountnumber

The amount in beneficiary's currency

Example: 234567.89
fee_amountnumber

The fee charged for this transaction

Example: 2.5
fee_currencystring

The fee currency

Example: "PHP"
fx_ratenumber

The forex currency rate used in the transaction

Example: 1.47289
errorsArray of objects

A list of payout errors

categorystringrequired
Enum"TRANSACTION""VALIDATION""AUTHZ""INTERNAL""MISCELLANEOUS""FUND""ACCOUNT""COMPLIANCE"
titlestringrequired
codestringrequired
detailstringrequired
Response
application/json
{
  "payout_partner_id": "65606de6-d86e-468e-8e69-55184fddf40c",
  "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
  "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  "external_transaction_id": "string",
  "external_request_id": "string",
  "ripplenet_payment_id": "7bb2080a-9fd7-4f64-af96-119671501c9c",
  "payout_status": "NOT_STARTED",
  "created_at": "2019-08-24T14:15:22Z",
  "payout_details": {
    "beneficiary_currency": "PHP",
    "sender_amount": 234567.89,
    "sender_currency": "USD",
    "fx_rate": 1.47289,
    "beneficiary_amount": 234567.89
  },
  "errors": [
    { … }
  ]
}

Pre-validate payout fields

Request

Returns result of pre-validation based of provided payout fields

Security
oauth2
Bodyapplication/jsonrequired
payout_payment_idstring(uuid)required

The id of the payment

payout_method_idstring(uuid)required

The id of the payout method to use

payout_instructionsobjectrequired
PmtIdobject

Set of elements used to reference a payment instruction.

InstrIdstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.

EndToEndIdstring<= 35 characters

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

TxIdstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.

UETRstring<= 36 characters^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

Unique End-to-end Transaction Reference, generated by the Payer and passed through, without modification by the payment participants through to the beneficiary.

ClrSysRefstring<= 35 characters

Unique reference, as assigned by a clearing system, to unambiguously identify the instruction.

IntrBkSttlmAmtobject

ISO20022 pacs.008.001.11 FIToFICustomerCreditTransferV11 field - Amount of money moved between the instructing agent and the instructed agent.

Amountnumberrequired

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217

Ccystring^[A-Z]{3,}$required

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

InstdAmtobject

ISO20022 pacs.008.001.11 FIToFICustomerCreditTransferV11 field - Amount of money moved between the instructing agent and the instructed agent.

Amountnumberrequired

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217

Ccystring^[A-Z]{3,}$required

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Cdtrobject

Party to which an amount of money is due.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CdtrAcctobject

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Idobjectrequired

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

ClrSysobject

Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.

Prtrystring<= 35 characters

Clearing system identification in a proprietary form.

PmtTpInfobject

Set of elements used to further specify the type of transaction.

InstrPrtystring

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. List based on ISO20022 Priority2Code List

Enum"HIGH""NORM"
ClrChanlstring

List based on ISO20022 ClearingChannel2Code List

Enum"RTGS""RTNS""MPNS""BOOK"
CtgyPurpobject

Specifies the high level purpose of the instruction based on a set of pre-defined categories.

Prtrystring<= 35 characters

Field to support proprietary value

Cdstring

List based on ISO20022 ExternalCategoryPurpose1Code List

Enum"BONU""CASH""CBLK""CCRD""CORT""DCRD""DIVI""DVPM""EPAY""FCIN"
SvcLvlobject

Agreement under which or rules under which the transaction should be processed.

Cdstring

List based on ISO20022 List ExternalServiceLevel1Code

Enum"BKTR""NPCA""NUGP""NURG""PRPT""SDVA""SEPA""SVDE""URGP""URNS"
Prtrystring<= 35 characters

Field to support proprietary value

LclInstrmobject

User community specific instrument.

Cdstring

List based on ISO20022 List ExternalLocalInstrument1Code

Enum"DDMC""DDMP""DDMU""TRF""82""83""CPP""RTR""GST""DDT"
Prtrystring<= 35 characters

Field to support proprietary value

ChrgBrstring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. Use ISO ChargeBearerType1Code list, supported values are CRED, DEBT & SHAR.

Enum"DEBT""CRED""SHAR"
UltmtDbtrobject

Ultimate party that owes an amount of money to the (ultimate) creditor.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

InitgPtyobject

Party that initiates the payment.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Dbtrobject

Party that owes an amount of money to the (ultimate) creditor.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

DbtrAcctobject

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

DbtrAgtobject

Financial institution servicing an account for the debtor.

FinInstnIdobject

Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

BICFIstring^([a-zA-Z0-9_-]){8,11}$

Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

ClrSysMmbIdobject

Information used to identify a member within a clearing system.

PstlAdrobject
Othrobject

Unique identification of an agent, as assigned by an institution, using an identification scheme.

BrnchIdobject

Identifies a specific branch of a financial institution.

Idstring<= 35 characters

Unique and unambiguous identification of a branch of a financial institution.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
DbtrAgtAcctobject

Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

IBANstring

IBAN for the account.

Othrobject
Tpobject

Nature or use of the account.

Cdstring

List based on ISO20022 ExternalCashAccountType1Code List

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"
Prtrystring<= 35 characters

Field to support proprietary value

Ccystring^[A-Z]{3,}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds.

Nmstring<= 140 characters

Name by which the account is known and which is usually used to identify the account.

Prxyobject

Specifies an alternate assumed name for the identification of the account.

Idobject

Specifies the unique identification of an account as assigned by the account servicer.

Tpobject

Nature or use of the account.

CdtrAgtobject

Financial institution servicing an account for the creditor.

FinInstnIdobject

Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

BICFIstring^([a-zA-Z0-9_-]){8,11}$

Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

ClrSysMmbIdobject

Information used to identify a member within a clearing system.

PstlAdrobject
Othrobject

Unique identification of an agent, as assigned by an institution, using an identification scheme.

BrnchIdobject

Identifies a specific branch of a financial institution.

Idstring<= 35 characters

Unique and unambiguous identification of a branch of a financial institution.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

PstlAdrobject
UltmtCdtrobject

Ultimate party to which an amount of money is due.

Nmstring<= 140 characters

Name by which the party is known and which is usually used to identify the party.

StrdNmobject
FirstNmstring<= 30 characters

First name by which the party is known and which is usually used to identify the party.

MidNmstring<= 30 characters

Middle name by which the party is known and which is usually used to identify the party.

LastNmstring<= 30 characters

Last name by which the party is known and which is usually used to identify the party.

LastNm2string<= 30 characters

Secondary last name by which the party is known and which is usually used to identify the party.

NtrlNmstring<= 140 characters

Name in local character set or language.

Titlestring<= 20 characters

Title by which the party is known and which is usually used to identify the party.

CtryOfResstring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

PstlAdrobject
AdrTpstring

List based on ISO20022 AddressType1Code List

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
AdrLineArray of strings<= 70 characters

Information that locates and identifies the address for the party.

Deptstring<= 70 characters

Information that locates and identifies the department for the party.

SubDeptstring<= 70 characters

Information that locates and identifies the sub department for the party.

StrtNmstring<= 70 characters

Information that locates and identifies the street name for the party, as defined by postal services.

BldgNbstring<= 16 characters

Information that locates and identifies the building number for the party, as defined by postal services.

PstCdstring<= 16 characters

Information that locates and identifies postal code for the party, as defined by postal services.

TwnNmstring<= 35 characters

Information that locates and identifies the city / town for the party, as defined by postal services.

CtrySubDvsnstring<= 35 characters

Information that locates and identifies the state / county for the party, as defined by postal services.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

CtctDtlsobject

Contact Details for the individual or organization

CtctDtlsobject

Set of elements used to indicate how to contact the party.

Idobject

Unique and unambiguous way to identify an individual or organization.

OrgIdobject

Unique and unambiguous way to identify an individual or organization.

PrvtIdobject

Unique and unambiguous identification of a person, e.g., passport.

InstForCdtrAgtobject

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

Cdstring

List based on ISO20022 Instruction3Code List

Enum"CHQB""HOLD""PHOB""TELB"
InstrInfstring<= 140 characters

Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.

Purpobject

Underlying reason for the payment transaction.

Cdstring

Underlying reason for the payment transaction, as published in an external purpose code list. Based on ISO20022 ExternalPurpose1Code List

Enum"BKDF""BKFE""BKFM""BKIP""BKPP""CBLK""CDCB""CDCD""CDCS""CDDP"
Prtrystring<= 35 characters

Field to support proprietary value

RgltryRptgobject

Information needed due to regulatory and statutory requirements.

DbtCdtRptgIndstring

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.

Enum"CRED""DEBT""BOTH"
Authrtyobject

Entity requiring the regulatory reporting information.

Nmstring<= 140 characters

Name of the entity requiring the regulatory reporting information.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Dtlsobject

Set of elements used to provide details on the regulatory reporting information.

Tpstring<= 35 characters

Specifies the type of the information supplied in the regulatory reporting details.

Dtstring(date-time)

Date related to the specified type of regulatory reporting details.

Ctrystring^[A-Z]{2}$

Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.

Cdstring<= 10 characters

Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.

Amtobject

Amount of money to be reported for regulatory and statutory requirements.

Infstring<= 35 characters

Additional details that cater for specific domestic regulatory requirements.

RltdRmtInfobject

Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.

RmtIdstring<= 35 characters

Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice.

RmtLctnDtlsobject

Set of elements used to provide information on the location and/or delivery of the remittance information.

Mtdstring

List based on ISO 20022 RemittanceLocationMethod2Code List

Enum"FAXI""EDIC""URID""EMAL""POST""SMSM"
ElctrncAdrstring<= 2048 characters

Electronic address to which an agent is to send the remittance information.

PstlAdrobject

Postal address to which an agent is to send the remittance information.

RmtInfobject

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Ustrdstring<= 140 characters

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. Please note, should new lines be required in this field, should be used to denote a new line.

Strdobject

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.

RfrdDocInfobject

Provides the identification and the content of the referred document.

RfrdDocAmtobject

Provides details on the amounts of the referred document.

CdtrRefInfobject

Reference information provided by the creditor to allow the identification of the underlying documents.

Invcrobject

Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor.

Invceeobject

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

TaxRmtobject

Provides remittance information about a payment made for tax-related purposes.

GrnshmtRmtobject

Provides remittance information about a payment for garnishment-related purposes.

AddtlRmtInfArray of arrays

Additional information, in the form of an array of strings, to complement the structured remittance information. Maximum of 4 lines to ensure consistency with the ISO20022 specification.

original_message_pacs008string

Provides the ability to include the original PACS.008 message

original_message_mt103string

Provides the ability to include the original MT103 message

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payouts/validation \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payout_payment_id": "b22dc334-d1d3-4646-a89e-3e6d455f404a",
    "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
    "payout_instructions": {
      "PmtId": {
        "InstrId": "string",
        "EndToEndId": "string",
        "TxId": "string",
        "UETR": "string",
        "ClrSysRef": "string"
      },
      "IntrBkSttlmAmt": {
        "Amount": 0,
        "Ccy": "string"
      },
      "InstdAmt": {
        "Amount": 0,
        "Ccy": "string"
      },
      "Cdtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "CdtrAcct": {
        "Nm": "string",
        "Ccy": "string",
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        }
      },
      "ClrSys": {
        "Prtry": "string"
      },
      "PmtTpInf": {
        "InstrPrty": "HIGH",
        "ClrChanl": "RTGS",
        "CtgyPurp": {
          "Prtry": "string",
          "Cd": "BONU"
        },
        "SvcLvl": {
          "Cd": "BKTR",
          "Prtry": "string"
        },
        "LclInstrm": {
          "Cd": "DDMC",
          "Prtry": "string"
        }
      },
      "ChrgBr": "DEBT",
      "UltmtDbtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "InitgPty": {
        "Nm": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        },
        "CtryOfRes": "string",
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        }
      },
      "Dbtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        }
      },
      "DbtrAcct": {
        "Nm": "string",
        "Ccy": "string",
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        }
      },
      "DbtrAgt": {
        "FinInstnId": {
          "BICFI": "string",
          "Nm": "string",
          "ClrSysMmbId": {
            "MmbId": "string",
            "ClrSysId": {
              "Cd": "ATBLZ",
              "Prtry": "string"
            }
          },
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          },
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "string",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "BrnchId": {
          "Id": "string",
          "Nm": "string",
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          }
        }
      },
      "DbtrAgtAcct": {
        "Id": {
          "IBAN": "string",
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "AIIN",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "Tp": {
          "Cd": "CACC",
          "Prtry": "string"
        },
        "Ccy": "string",
        "Nm": "string",
        "Prxy": {
          "Id": {
            "IBAN": "string",
            "Othr": {
              "Id": "string",
              "SchmeNm": {
                "Cd": "AIIN",
                "Prtry": "string"
              },
              "Issr": "string"
            }
          },
          "Tp": {
            "Cd": "CACC",
            "Prtry": "string"
          }
        }
      },
      "CdtrAgt": {
        "FinInstnId": {
          "BICFI": "string",
          "Nm": "string",
          "ClrSysMmbId": {
            "MmbId": "string",
            "ClrSysId": {
              "Cd": "ATBLZ",
              "Prtry": "string"
            }
          },
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          },
          "Othr": {
            "Id": "string",
            "SchmeNm": {
              "Cd": "string",
              "Prtry": "string"
            },
            "Issr": "string"
          }
        },
        "BrnchId": {
          "Id": "string",
          "Nm": "string",
          "PstlAdr": {
            "AdrTp": "ADDR",
            "AdrLine": [
              "string"
            ],
            "Dept": "string",
            "SubDept": "string",
            "StrtNm": "string",
            "BldgNb": "string",
            "PstCd": "string",
            "TwnNm": "string",
            "CtrySubDvsn": "string",
            "Ctry": "string"
          }
        }
      },
      "UltmtCdtr": {
        "Nm": "string",
        "StrdNm": {
          "FirstNm": "string",
          "MidNm": "string",
          "LastNm": "string",
          "LastNm2": "string",
          "NtrlNm": "string",
          "Title": "string"
        },
        "CtryOfRes": "string",
        "PstlAdr": {
          "AdrTp": "ADDR",
          "AdrLine": [
            "string"
          ],
          "Dept": "string",
          "SubDept": "string",
          "StrtNm": "string",
          "BldgNb": "string",
          "PstCd": "string",
          "TwnNm": "string",
          "CtrySubDvsn": "string",
          "Ctry": "string"
        },
        "CtctDtls": {
          "CtctDtls": {
            "NmPrfx": "DOCT",
            "Nm": "string",
            "PhneNb": "string",
            "MobNb": "string",
            "FaxNb": "string",
            "EmailAdr": "string",
            "Othr": "string"
          }
        },
        "Id": {
          "OrgId": {
            "AnyBIC": "string",
            "DtAndPlcofIncorprtn": {
              "DtofIncorprtn": "2019-08-24T14:15:22Z",
              "CtryofIncorprtn": "string"
            },
            "Othr": {
              "Id": "string",
              "Prtry": "string",
              "Issr": "string",
              "DtOfIss": "string",
              "DtOfIsse": "2019-08-24T14:15:22Z",
              "DtOfXpry": "2019-08-24T14:15:22Z",
              "SchmeNm": {
                "Cd": "BANK",
                "Prtry": "string"
              }
            },
            "RelShipToDbtr": "BRAN",
            "RelShipToCdtr": "BRAN",
            "Rprtv": {
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              }
            }
          },
          "PrvtId": {
            "DtAndPlcOfBirth": {
              "BirthDt": "2019-08-24T14:15:22Z",
              "PrvcOfBirth": "string",
              "CityOfBirth": "string",
              "CtryOfBirth": "string"
            },
            "Othr": {
              "Id": "string",
              "Issr": "string",
              "SchmeNm": {
                "Cd": "ARNU",
                "Prtry": "string"
              },
              "DtOfIss": "2019-08-24T14:15:22Z",
              "DtOfExpr": "2019-08-24T14:15:22Z",
              "MrzNb": "string"
            },
            "Gender": "string",
            "Profession": "string",
            "RelShipToDbtr": "CHIL",
            "Ntlty": "str",
            "Residence": "str",
            "Citizenship": {
              "Ntlty": "str",
              "MnrId": "str",
              "StartDt": "2019-08-24T14:15:22Z",
              "EndDt": "2019-08-24T14:15:22Z"
            }
          }
        }
      },
      "InstForCdtrAgt": {
        "Cd": "CHQB",
        "InstrInf": "string"
      },
      "Purp": {
        "Cd": "BKDF",
        "Prtry": "string"
      },
      "RgltryRptg": {
        "DbtCdtRptgInd": "CRED",
        "Authrty": {
          "Nm": "string",
          "Ctry": "string"
        },
        "Dtls": {
          "Tp": "string",
          "Dt": "2019-08-24T14:15:22Z",
          "Ctry": "string",
          "Cd": "string",
          "Amt": {
            "amount": "string",
            "Ccy": "string"
          },
          "Inf": "string"
        }
      },
      "RltdRmtInf": {
        "RmtId": "string",
        "RmtLctnDtls": {
          "Mtd": "FAXI",
          "ElctrncAdr": "string",
          "PstlAdr": {
            "Nm": "string",
            "Adr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            }
          }
        }
      },
      "RmtInf": {
        "Ustrd": "string",
        "Strd": {
          "RfrdDocInf": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "MSIN",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Nb": "string",
            "RltdDt": "2019-08-24T14:15:22Z",
            "LineDtls": []
          },
          "RfrdDocAmt": {
            "DuePyblAmt": {
              "amount": "string",
              "currency": "string"
            },
            "DscntApldAmt": {
              "Tp": {
                "Cd": "APDS",
                "Prtry": "string"
              },
              "Amt": {
                "amount": "string",
                "currency": "string"
              }
            },
            "CdtNoteAmt": {
              "amount": "string",
              "currency": "string"
            },
            "TaxAmt": {
              "Tp": {
                "Cd": "CITY",
                "Prtry": "string"
              },
              "Amt": {
                "amount": "string",
                "currency": "string"
              }
            },
            "AdjstmntAmtAndRsn": {
              "Amt": {
                "amount": "string",
                "currency": "string"
              },
              "CdtDbtInd": "CRDT",
              "Rsn": "stri",
              "AddtlInf": "string"
            },
            "RmtdAmt": {
              "amount": "string",
              "currency": "string"
            }
          },
          "CdtrRefInf": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "RADM",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Ref": "string"
          },
          "Invcr": {
            "Nm": "string",
            "StrdNm": {
              "FirstNm": "string",
              "MidNm": "string",
              "LastNm": "string",
              "LastNm2": "string",
              "NtrlNm": "string",
              "Title": "string"
            },
            "CtryOfRes": "string",
            "PstlAdr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            },
            "Id": {
              "OrgId": {
                "AnyBIC": "string",
                "DtAndPlcofIncorprtn": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "RelShipToDbtr": "BRAN",
                "RelShipToCdtr": "BRAN",
                "Rprtv": {
                  "StrdNm": {}
                }
              },
              "PrvtId": {
                "DtAndPlcOfBirth": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "Gender": "string",
                "Profession": "string",
                "RelShipToDbtr": "CHIL",
                "Ntlty": "str",
                "Residence": "str",
                "Citizenship": {}
              }
            },
            "CtctDtls": {
              "CtctDtls": {
                "NmPrfx": "DOCT",
                "Nm": "string",
                "PhneNb": "string",
                "MobNb": "string",
                "FaxNb": "string",
                "EmailAdr": "string",
                "Othr": "string"
              }
            }
          },
          "Invcee": {
            "Nm": "string",
            "StrdNm": {
              "FirstNm": "string",
              "MidNm": "string",
              "LastNm": "string",
              "LastNm2": "string",
              "NtrlNm": "string",
              "Title": "string"
            },
            "CtryOfRes": "string",
            "PstlAdr": {
              "AdrTp": "ADDR",
              "AdrLine": [
                "string"
              ],
              "Dept": "string",
              "SubDept": "string",
              "StrtNm": "string",
              "BldgNb": "string",
              "PstCd": "string",
              "TwnNm": "string",
              "CtrySubDvsn": "string",
              "Ctry": "string"
            },
            "Id": {
              "OrgId": {
                "AnyBIC": "string",
                "DtAndPlcofIncorprtn": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "RelShipToDbtr": "BRAN",
                "RelShipToCdtr": "BRAN",
                "Rprtv": {
                  "StrdNm": {}
                }
              },
              "PrvtId": {
                "DtAndPlcOfBirth": {},
                "Othr": {
                  "SchmeNm": {}
                },
                "Gender": "string",
                "Profession": "string",
                "RelShipToDbtr": "CHIL",
                "Ntlty": "str",
                "Residence": "str",
                "Citizenship": {}
              }
            },
            "CtctDtls": {
              "CtctDtls": {
                "NmPrfx": "DOCT",
                "Nm": "string",
                "PhneNb": "string",
                "MobNb": "string",
                "FaxNb": "string",
                "EmailAdr": "string",
                "Othr": "string"
              }
            }
          },
          "TaxRmt": {
            "Cdtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string"
            },
            "Dbtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string",
              "Authstn": {
                "Titl": "string",
                "Nm": "string"
              }
            },
            "UltmtDbtr": {
              "TaxId": "string",
              "RegnId": "string",
              "TaxTp": "string",
              "Authstn": {
                "Titl": "string",
                "Nm": "string"
              }
            },
            "AdmstnZone": "string",
            "RefNb": "string",
            "Mtd": "string",
            "TtlTaxblBaseAmt": {
              "amount": "string",
              "currency": "string"
            },
            "TtlTaxAmt": {
              "amount": "string",
              "currency": "string"
            },
            "Dt": "2019-08-24T14:15:22Z",
            "SeqNb": 0,
            "Rcrd": {
              "Tp": "string",
              "Ctgy": "string",
              "CtgyDtls": "string",
              "DbtrSts": "string",
              "CertId": "string",
              "FrmsCd": "string",
              "Prd": {
                "Yr": "2019-08-24T14:15:22Z",
                "Tp": "MM01",
                "FrToDt": {}
              },
              "TaxAmt": {
                "Rate": 100,
                "TtlTaxblBaseAmt": {},
                "TtlAmt": {},
                "Dtls": {
                  "Prd": {},
                  "Amt": {}
                },
                "AddtlInf": "string"
              }
            }
          },
          "GrnshmtRmt": {
            "Tp": {
              "CdOrPrtry": {
                "Cd": "GNCS",
                "Prtry": "string"
              },
              "Issr": "string"
            },
            "Grnshee": {
              "Nm": "string",
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              },
              "CtryOfRes": "string",
              "PstlAdr": {
                "AdrTp": "ADDR",
                "AdrLine": [
                  null
                ],
                "Dept": "string",
                "SubDept": "string",
                "StrtNm": "string",
                "BldgNb": "string",
                "PstCd": "string",
                "TwnNm": "string",
                "CtrySubDvsn": "string",
                "Ctry": "string"
              },
              "Id": {
                "OrgId": {
                  "DtAndPlcofIncorprtn": {},
                  "Othr": {},
                  "Rprtv": {}
                },
                "PrvtId": {
                  "DtAndPlcOfBirth": {},
                  "Othr": {},
                  "Citizenship": {}
                }
              },
              "CtctDtls": {
                "CtctDtls": {}
              }
            },
            "GrnshmyAdmstr": {
              "Nm": "string",
              "StrdNm": {
                "FirstNm": "string",
                "MidNm": "string",
                "LastNm": "string",
                "LastNm2": "string",
                "NtrlNm": "string",
                "Title": "string"
              },
              "CtryOfRes": "string",
              "PstlAdr": {
                "AdrTp": "ADDR",
                "AdrLine": [
                  null
                ],
                "Dept": "string",
                "SubDept": "string",
                "StrtNm": "string",
                "BldgNb": "string",
                "PstCd": "string",
                "TwnNm": "string",
                "CtrySubDvsn": "string",
                "Ctry": "string"
              },
              "Id": {
                "OrgId": {
                  "DtAndPlcofIncorprtn": {},
                  "Othr": {},
                  "Rprtv": {}
                },
                "PrvtId": {
                  "DtAndPlcOfBirth": {},
                  "Othr": {},
                  "Citizenship": {}
                }
              },
              "CtctDtls": {
                "CtctDtls": {}
              }
            },
            "RefNb": "string",
            "Dt": "2019-08-24T14:15:22Z",
            "RmtdAmt": {
              "amount": "string",
              "currency": "string"
            },
            "FmlyMdcllnsrncInd": true,
            "MplyeeTermntnInd": true
          },
          "AddtlRmtInf": []
        }
      },
      "original_message_pacs008": "string",
      "original_message_mt103": "string"
    }
  }'

Responses

Successful validation

Bodyapplication/json
payout_method_idstring(uuid)required

The id of the payout method

validbooleanrequired

A flag indicating that provided payload is valid

errorsArray of objects

A list of payout errors

categorystringrequired
Enum"TRANSACTION""VALIDATION""AUTHZ""INTERNAL""MISCELLANEOUS""FUND""ACCOUNT""COMPLIANCE"
titlestringrequired
codestringrequired
detailstringrequired
Response
application/json
{
  "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
  "valid": true,
  "errors": [
    { … }
  ]
}

PayoutsV2

Operations

Quotes

Operations

Webhooks

Operations

Tranglo

Operations

Routing

Operations

Data Requirement

Operations