{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/api-docs/building-payment-request-body/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Building the payment request body

\n

When you call the POST /v2/payments operation to create a payment, you must include a request body containing required payment information, such as the beneficiary identity and the purpose of the payment.

\n

The following sections walk you through building an example payment request body.

\n

The payment request body

\n

The payment request body accepts key-value pairs in the JSON format.

\n

To successfully create a payment, you must include all required properties depending on the type of payment you want to make:

\n\n

The following tabs show sample payment request body for each type of payment:

\n\n
\n
\n Individual/Business paymentThird-party payment\n
\n
\n
\n
\n
Copy
\n
Copied!
\n
\n 
{\n  \"quoteId\": \"7ea3399c-1234-5678-8d8f-d320ea406630\",\n  \"beneficiaryIdentityId\": \"11111111-abcd-2222-efgh-333333333333\",\n  \"sourceOfCash\": \"SVGS\",\n  \"purposeCode\": \"OTHR\"\n}
\n
\n
\n
Copy
\n
Copied!
\n
\n 
{\n  \"quoteId\": \"7ea3399c-1234-5678-8d8f-d320ea406630\",\n  \"originatorIdentityId\": \"12345678-abcd-1234-abcd-123456789123\",\n  \"beneficiaryIdentityId\": \"11111111-abcd-2222-efgh-333333333333\",\n  \"sourceOfCash\": \"SVGS\",\n  \"purposeCode\": \"OTHR\"\n}
\n
\n
\n \n

The following sections provide more details about each property.

\n

quoteId

\n

This property identifies the quote that you previously fetched and want to execute to send the payment.

\n

The response from the POST /v2/quotes/quote-collection operation contains a quote object that's uniquely identified by its quoteId value. This is the value you must specify in the request body of your POST /v2/payments call.

\n

beneficiaryIdentityId

\n

This property identifies the beneficiary of this payment. The value of this property is the identityId of an existing beneficiary.

\n

To get a beneficiary's identity ID, call the GET /v2/identities operation with the query parameter identityType set to BENEFICIARY. You can get the beneficiary's identityId from the response. For more information, see the Get an identity tutorial .

\n

originatorIdentityId

\n

This property identifies the party that originates the payment. The value of this property is the identityId of an existing originator.

\n
Note

You need to provide the originatorIdentityId only if you are originating a payment on behalf of another business. For example, if you're paying a business or an individual on behalf of your customer, then provide the originatorIdentityId that contains identifying information about your customer. You don't need to include this property if you are the payment originator.

\n

To get an existing originator's identityId, call the GET /v2/identities operation with the query parameter identityType set to ORIGINATOR. You can get the originator's identityId from the response. For more information, see the Get an identity tutorial.

\n

sourceOfCash

\n

This property indicates the source of funds for this payment. This value must be equal to one of the known values in the table below.

\n
\n Expand to see the list of known values for sourceOfCash\n

Known values for sourceOfCash

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
ALMYAlimony
CASHCash Proceeds
COMPCompensation
EMINEmployee Income
GIFTGift
INHEInheritance
INLQInsurance Premium Liquidation
PACAPaid Up Capital
REDMRedemption
REPYRetirement Policy
RESTReal Estate Sale
SALESale Of Goods
SEAQSale Aquisition Corporation
SELFSelf Employment Income
SVGSSavings
WINSWinnings
\n
\n

purposeCode

\n

This property indicates the purpose of the payment.

\n
Note

Reach out to your Ripple liaison to get the value for your transaction.

\n","headings":[{"value":"Building the payment request body","depth":1},{"value":"The payment request body","depth":2},{"value":"quoteId","depth":3},{"value":"beneficiaryIdentityId","depth":3},{"value":"originatorIdentityId","depth":3},{"value":"sourceOfCash","depth":3},{"value":"purposeCode","depth":3}]},"contentItem":{"data":{"lastModified":"2025-11-13T00:24:58.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":true,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"cc705043-349b-59bb-b3e0-e3d1345c94ae__redocly content/api-docs/building-payment-request-body/","seo":{"title":"Building the payment request body","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"api-docs/building-payment-request-body.md","pageBaseUrl":"/api-docs/building-payment-request-body","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Building the payment request body","id":"building-the-payment-request-body"},{"depth":2,"value":"The payment request body","id":"the-payment-request-body"},{"depth":3,"value":"quoteId","id":"quoteid"},{"depth":3,"value":"beneficiaryIdentityId","id":"beneficiaryidentityid"},{"depth":3,"value":"originatorIdentityId","id":"originatoridentityid"},{"depth":3,"value":"sourceOfCash","id":"sourceofcash"},{"depth":3,"value":"purposeCode","id":"purposecode"}]},"data":{"title":""},"catalogInfo":null,"link":"/api-docs/building-payment-request-body/","sidebarName":"__root-sidebar__-data-69308394-sidebars.yaml","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}