Payment Batches

Create a payment batch

Creates an empty batch. Add recipients with the recipient endpoints, then start the payouts with POST /api/v1/payment-batch/{batchId}/withdraw. Requires the PAYMENT_BATCH.CREATE key permission.

post/api/v1/payment-batch

Request

Base URL
https://sandbox.api.afriex.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/payment-batch/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

A label for the batch.

Example request

{
  "sourcePaymentMethod": {
    "currencyCode": "USD"
  }
}

Response

The batch was created

Example response

{
  "data": {
    "sourcePaymentMethod": {
      "currencyCode": "USD"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.