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 OCT Payment Request
        • GETList OCT Payment Requests
        • GETRetrieve OCT Payment Request
Get a Demo
LogoLogo
API ReferencePaymentsOCT

Create OCT Payment Request

POST
https://host.com/v2/payments/oct/
POST
/v2/payments/oct/
$curl -X POST https://host.com/v2/payments/oct/ \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "consumer_id": "abc123",
> "external_payment_card_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
> "amount": 100
>}'
201Created
1{
2 "id": "a1b2c3d4-0000-4000-8000-000000000002",
3 "amount": 100,
4 "direction": "Push",
5 "status": "completed",
6 "consumer_id": "string",
7 "external_payment_card_id": "string",
8 "fee_amount": 0
9}

Create an OCT (Original Credit Transaction) request to push funds directly to a consumer’s payment card

Was this page helpful?
Previous

List OCT Payment Requests

Next
Built with

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
consumer_idstringRequired
Unique identifier of the consumer receiving the transfer.
external_payment_card_idstringRequiredformat: "uuid"
External ID of the payment card to credit funds to.
amountdoubleRequired
Amount to push in USD.
descriptionstringOptional
Optional description for the transaction.

Response

idstringformat: "uuid"
Unique identifier for this payment.
amountdouble
Transfer amount in USD.
directionstring

Always Push for OCT transactions.

statusstring
Current payment status.
consumer_idstring
Identifier of the consumer associated with this payment.
external_payment_card_idstringformat: "uuid"
External ID of the payment card that was credited.
fee_amountdouble
Fee amount charged for this transaction.