Sign in

v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-017364211.0 KB
Payments

Create Direct Payment

Creates a new direct payment that is immediately sent to the specified receiver if they have a valid registered wallet. Direct payments bypass the disbursement workflow and are processed instantly.

post/payments

Request body

amountstring required

The payment amount

external_payment_idstring

Optional external payment identifier

Response

Direct payment created successfully

idstring
amountstring

The amount of the payment

stellar_transaction_idstring

The ID of the transaction in the Stellar network. It can be used to track the payment in the Stellar network using Stellar Laboratory, or StellarExpert.

circle_transfer_request_idstring

The Circle transfer request ID. It is only present when the payment was made using Circle.

stellar_operation_idstring
status'DRAFT' | 'READY' | 'PENDING' | 'PAUSED' | 'SUCCESS' | 'FAILED' | 'CANCELED'

The status of the payment

type'DISBURSEMENT' | 'DIRECT'

The type of the payment.

external_payment_idstring

Optional external payment identifier provided by the client.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "ddf22f55-3259-4822-a4e2-ce01334997f4",
  "amount": "100.00",
  "stellar_transaction_id": "0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b",
  "circle_transfer_request_id": "74a68b6a-3f67-424b-b8b0-e593a19d7463",
  "status_history": [
    {
      "timestamp": "2023-02-03T10:45:51Z"
    }
  ],
  "disbursement": {
    "id": "c51ba1d5-52d3-412f-a59c-6ef32d59ab43",
    "name": "disbursement-june-29",
    "receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
    "status_history": [
      {
        "user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
        "timestamp": "2023-02-03T10:45:51Z"
      }
    ],
    "file_name": "disbursement-feb-03-2023.csv",
    "created_at": "2023-06-30T01:22:57.831975Z",
    "updated_at": "2023-06-30T01:22:58.316511Z"
  },
  "asset": {
    "id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
    "code": "USDC",
    "issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
    "created_at": "2023-02-03T10:45:51Z",
    "updated_at": "2023-02-03T10:45:51Z",
    "deleted_at": "2023-06-03T10:55:51Z"
  },
  "receiver_wallet": {
    "id": "803031d4-1d04-4879-b6d9-dc5641f9988e",
    "receiver": {
      "id": "029e2ed0-feb6-4c40-8b47-0836a85741a2"
    },
    "wallet": {
      "id": "5ada9ed5-455a-4782-a0ee-160767e0deb1",
      "name": "Vibrant Assist",
      "homepage": "https://vibrantapp.com",
      "sep_10_client_domain": "api-dev.vibrantapp.com",
      "deep_link_schema": "https://vibrantapp.com/sdp-dev",
      "enabled": true
    },
    "stellar_address": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
    "created_at": "2023-02-03T10:45:51.000Z",
    "updated_at": "2023-02-03T10:45:51.000Z",
    "invitation_sent_at": "2023-02-09T10:45:51.000Z",
    "status_history": [
      {
        "timestamp": "2023-02-10T10:45:51Z"
      }
    ],
    "otp_confirmed_at": "2023-02-10T10:45:51Z"
  },
  "external_payment_id": "payment-001",
  "created_at": "2023-02-03T10:45:51Z",
  "updated_at": "2023-02-03T10:45:51Z"
}