OpenAPI Document
  1. Payouts
OpenAPI Document
  • 1. Overview
    • 1. Overview
  • 2. Authentication
    • 2.1 Introduction
      • 2.1 Introduction
      • Generating an RSA key pair
    • 2.2 Creating the Bearer Token
      • 2.2 Creating the Bearer Token
      • Creating the token
      • Signature Examples
      • JWT Token Specification
      • Signature Examples
  • 3. Requests & Responses
    • 3.1 Requests
    • 3.2 Responses
    • 3.2 Responses
      • 3.2.1 Succes Responses
      • 3.2.2 Retrying Requests
      • 3.2.3 HTTP Status Codes
      • 3.2.4 Error Responses
        • Error Response Format
  • 4. Getting Started
    • 4.1 Pagination
      • 4.1 Pagination
    • 4.2 Rate Limiting
      • Rate Limits
    • 4.3 Idempotency
      • Idempotency Fields
    • 4.4 External ID and Metadata
      • 4.4 External ID and Metadata
  • 5. API
    • Health
      • 5.1 Test connectivity
      • 5.2 Test connectivity
    • Accounts
      • 5.3 Get Accounts
      • 5.4 Get Accounts
      • 5.5 Get Balances
    • Transfer
      • 5.6 Create a Transfer
    • Transactions
      • 5.7 Get Account Transactions
    • Conversions
      • 5.8 Get a Quote
      • 5.9 Execute a trade
    • Payouts
      • 5.10 Get Payouts
        GET
      • 5.11 Create Payout
        GET
      • 5.12 Get Payout Quotation
        POST
    • Card Account
      • 5.13 Create Card Account
      • 5.14 Get Card Account Transactions
    • Cards
      • 5.15 Issue Card
      • 5.16 Get Cards
      • 5.17 Activate Card
      • 5.18 Suspend Card
      • 5.19 Unsuspend Card
      • 5.20 Lock Card
      • 5.21 Unlock Card
      • 5.22 Cancel a card
      • 5.23 Get Card Senstiive Info
      • 5.24 Change Card PIN
      • 5.25 Control Spending
    • Digital Custody
      • 5.26 Get Supported Digital Assets
      • 5.27 Get Supported Blockchains
      • 5.28 Create Withdrawal Request
      • 5.29 Get Deposit Addresses
      • 5.30 Generate Deposit Address
    • Countries
      • 5.31 Get Countries
    • Positions
      • 5.32 Get Positions
    • Occupations
      • 5.33 Get Occupations
  • 6. Screenshot Illustration（api+image）
    • 6. Screenshot Illustration（api+image）
  1. Payouts

5.11 Create Payout

GET
https://access.sandbox.orzcash.com/v1/payouts

Request

Query Params
method
string 
required
xid
string 
required
xmetadata
integer 
required
destination
integer 
required
accountId
string 
required
6a3176fe-7715-4fe0-a548-034912d7f800
quoteId
string 
optional
idempotencyKey
string 
optional
Body Params application/json
xid
string 
required
xmetadata
object 
required
method
string 
required
destination
object 
required
{ "type": "BANK_ACCOUNT", "accountNumber": 123456, "routingNumber": 1234, "country": "US", "bankName": "Bank of America", "bankAddress": "123 Main St, New York, NY 10001, USA", "swiftCode": "BOFAUS3N", "accountHolderName": "John Doe", "accountHolderAddress": "456 Park Ave, New York, NY 10022, USA" }
accountId
string 
required
quoteId
string 
required
idempotencyKey
string 
required
Example
    {
        "xid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "xmetadata": {},
        "method": "BANK_SWIFT",
        "quoteId":"quoteId",
        "destination": {
          "type": "BANK_ACCOUNT",
          "accountNumber": 123456,
          "routingNumber": 1234,
          "country": "US",
          "bankName": "Bank of America",
          "bankAddress": "123 Main St, New York, NY 10001, USA",
          "swiftCode": "BOFAUS3N",
          "accountHolderName": "John Doe",
          "accountHolderAddress": "456 Park Ave, New York, NY 10022, USA"
        },
        "accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
        "idempotencyKey":"6a3176fe"
      }

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://access.sandbox.orzcash.com/v1/payouts?method=&xid&xmetadata&destination&accountId&quoteId=&idempotencyKey=' \
--header 'Content-Type: application/json' \
--data-raw '{
        "xid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "xmetadata": {},
        "method": "BANK_SWIFT",
        "quoteId":"quoteId",
        "destination": {
          "type": "BANK_ACCOUNT",
          "accountNumber": 123456,
          "routingNumber": 1234,
          "country": "US",
          "bankName": "Bank of America",
          "bankAddress": "123 Main St, New York, NY 10001, USA",
          "swiftCode": "BOFAUS3N",
          "accountHolderName": "John Doe",
          "accountHolderAddress": "456 Park Ave, New York, NY 10022, USA"
        },
        "accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
        "idempotencyKey":"6a3176fe"
      }'

Responses

🟢200success
application/json
Body
nextPageToken
string 
required
payouts
object 
required
[ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "xid": "string", "xmetadata": {}, "created": "2022-12-21T07:21:09.879Z", "method": "BANK_SWIFT", "destination": { "type": "BANK_ACCOUNT", "accountNumber": 123456, "routingNumber": 1234, "country": "US", "bankName": "Bank of America", "bankAddress": "123 Main St, New York, NY 10001, USA", "swiftCode": "BOFAUS3N", "accountHolderName": "John Doe", "accountHolderAddress": "456 Park Ave, New York, NY 10022, USA" }, "accountId": "6a3176fe-7715-4fe0-a548-034912d7f800", "sourceCurrency": "string", "sourceAmount": 0, "destinationCurrency": "RMB", "destinationAmount": 0, "rate": 0, "updated": "2022-12-21T07:21:09.879Z", "status": "requested" } ]
Example
{
    "nextPageToken": "string",
    "payouts": [
        {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "xid": "string",
            "xmetadata": {},
            "created": "2022-12-21T07:21:09.879Z",
            "method": "BANK_SWIFT",
            "destination": {
                "type": "BANK_ACCOUNT",
                "accountNumber": 123456,
                "routingNumber": 1234,
                "country": "US",
                "bankName": "Bank of America",
                "bankAddress": "123 Main St, New York, NY 10001, USA",
                "swiftCode": "BOFAUS3N",
                "accountHolderName": "John Doe",
                "accountHolderAddress": "456 Park Ave, New York, NY 10022, USA"
            },
            "accountId": "6a3176fe-7715-4fe0-a548-034912d7f800",
            "sourceCurrency": "string",
            "sourceAmount": 0,
            "destinationCurrency": "RMB",
            "destinationAmount": 0,
            "rate": 0,
            "updated": "2022-12-21T07:21:09.879Z",
            "status": "requested"
        }
    ]
}
Modified at 2023-01-03 10:45:24
Previous
5.10 Get Payouts
Next
5.12 Get Payout Quotation
Built with