Sign in
Payments

Payout

Initiate a Raast payout to credit a beneficiary IBAN

post/v1/aggregators/{raast-aggregator-id}/payout

Request

  • Base URL: https://api.getsafepay.com/raastwire
  • URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/payout
  • Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Request body

request_idstring uuid required

Unique UUID v4 supplied by the client to ensure idempotency (exactly 36 characters with hyphens).

amountstring required

Amount to credit in PKR, expressed as a string to preserve formatting

creditor_ibanstring required

Destination IBAN that receives the payout

Example request

{
  "request_id": "d44940a1-663b-4d92-91e7-65438e4bf80b"
}

Response

This response contains details of a payout request

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "expires_at": "2025-03-13T09:12:34Z",
    "created_at": "2025-03-13T09:12:34Z",
    "updated_at": "2025-03-13T09:12:34Z",
    "payment_parties": [
      {
        "bank_account": {
          "created_at": "2025-03-13T09:12:34Z",
          "updated_at": "2025-03-13T09:12:34Z"
        },
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z"
      }
    ],
    "aggregator_merchant": {
      "bank_account": {
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z"
      },
      "raast_merchant": {
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z"
      },
      "rate_card": {
        "ratecard_kind": "RateCardKind_fixed",
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z"
      },
      "created_at": "2025-03-13T09:12:34Z",
      "updated_at": "2025-03-13T09:12:34Z"
    },
    "refunds": [
      {
        "msg_created_at": "2025-03-13T09:12:34Z",
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z"
      }
    ]
  }
}

Changes

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