For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get a Demo
Get StartedConceptsProductsGuidesUI ComponentsAPI Access
Get StartedConceptsProductsGuidesUI ComponentsAPI Access
    • Getting Started
    • Environments and Base URLs
    • Reference
  • API Reference
        • POSTCreate Peer To Peer Payment Request
        • GETList Peer To Peer Payment Responses
        • GETRetrieve Peer To Peer Payment Response
Get a Demo
LogoLogo
API ReferencePaymentsP2P

Create Peer To Peer Payment Request

POST
https://host.com/v2/payments/p2p/
POST
/v2/payments/p2p/
$curl -X POST https://host.com/v2/payments/p2p/ \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "originating_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
>  "receiving_account_id": "7cb94a21-1a3b-4891-9e12-6d1f5a2bc099",
>  "amount": 25,
>  "description": "Splitting dinner"
>}'
1{
2  "id": "a1b2c3d4-0000-4000-8000-000000000001",
3  "originating_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4  "receiving_account_id": "7cb94a21-1a3b-4891-9e12-6d1f5a2bc099",
5  "amount": 25,
6  "status": "pending",
7  "description": "Splitting dinner"
8}

Initiate a peer-to-peer transfer between two consumers on the authenticated partner’s network. Both accounts must be active secured-card accounts. Returns pending_review instead of an error when the sender exceeds the daily velocity limit (2 transfers per 24 hours).

Was this page helpful?
Previous

List Peer To Peer Payment Responses

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
originating_account_idstringRequiredformat: "uuid"

External ID of the sending consumer’s secured-card account.

receiving_account_idstringRequiredformat: "uuid"

External ID of the receiving consumer’s secured-card account.

amountdoubleRequired
Transfer amount in USD. Minimum 1.00. Maximum set by partner configuration.
descriptionstringOptional
Optional memo visible in both consumers' transaction history.

Response

Payment created successfully
idstringformat: "uuid"
Unique identifier for this P2P payment. Use it to poll status or retrieve details.
originating_account_idstring
External ID of the sending account.
receiving_account_idstring
External ID of the receiving account.
amountdouble
Transfer amount in USD.
statusenum

Current payment status. pending_review means the payment is held for compliance review (velocity limit exceeded) and will be processed once approved.

Allowed values:
descriptionstring
Memo provided at creation time.

Errors

422
Unprocessable Entity Error