Make Fiat Payouts

The following guide explains how you can make payouts to business or individual customers using the same endpoint.

To create a fiat payout for local payment rails, you must have the following:

  • Recipient's bank account details, including the bank code:
    • SCAN for GBP payments
    • IBAN and BIC for EUR payments
    • ABA Routing Number for USD payments
  • Recipient's account number.

If invalid bank details are provided, such as an incorrect bank code or account number, the payout request will be rejected with an error message returned.

To create a fiat payout for international payments via SWIFT, you must first acquire the following information:

  • Payee's full name or company name and address.
  • International Bank Account Number (IBAN)
  • Name and address of the payee's bank
  • Payee's SWIFT or Bank identifier Code (BIC) bank code.

📘

Metadata-supported endpoint

This endpoint allows you to include custom additional information with your request. The provided metadata will also be returned in the status endpoint for reference.

To make a payout, send the POST /payment/v1/payouts request with the corresponding payload:

{
"walletId": "a:24071743000626:go5SB1l:1",
"amount": {
    "value": "100.00",
    "currency": "GBP"
},
"paymentReference": "Ref112455",
"instruction": {
    "type": "FIAT",
    "beneficiary": {
        "details": {
            "beneficiaryType": "SELF_OWNED",
            "transferDestination": "LOCAL",
            "currency": "GBP",
            "businessDetails": {
                "businessName": "Company ABC"
            },
            "address": {
                "addressLine1": "Some address Line 1",
                "addressLine2": "Some address Line 2",
                "city": "Some city",
                "region": "Some region",
                "postCode": "ABCDEF",
                "country": "GB"
            },
            "bankDetails": {
                "accountNumber": "00015179",
                "code": "040825",
                "address": {
                    "country": "GB"
                }
            }
        }
    }
},
"requestDetails": {
    "originator": {
        "ipAddress": "5.57.72.118"
    }
},
"metadata": {
    "someKey": "someValue",
    "someKey2": {
        "someKey3": "someValue3"
    }
}
}
{
    "walletId": "a:24071743003474:xE95Oq7:1",
    "amount": {
        "value": "100",
        "currency": "EUR"
    },
    "paymentReference": "0IIJSsG4kz",
    "instruction": {
        "type": "FIAT",
        "beneficiary": {
            "details": {
                "beneficiaryType": "SELF_OWNED",
                "transferDestination": "LOCAL",
                "currency": "EUR",
                "businessDetails": {
                    "businessName": "Company ABC"
                },
                "address": {
                    "country": "FR"
                },
                "bankDetails": {
                    "accountNumber": "FR7630006000011234567890189",
                    "code": "AGRIFRPP",
                    "address": {
                        "country": "FR"
                    }
                }
            }
        }
    },
    "requestDetails": {
        "originator": {
            "ipAddress": "5.57.72.118"
        }
    },
    "metadata": {
        "someKey": "someValue",
        "someKey2": {
            "someKey3": "someValue3"
        }
    }
}
{
    "walletId": "a:24071743000626:go5SB1l:1",
    "amount": {
        "value": "100.00",
        "currency": "USD"
    },
    "paymentReference": "Ref112455",
    "instruction": {
        "type": "FIAT",
        "paymentMethod": "ACH",
        "beneficiary": {
            "details": {
                "beneficiaryType": "SELF_OWNED",
                "transferDestination": "LOCAL",
                "currency": "USD",
                "businessDetails": {
                    "businessName": "Company ABC"
                },
                "address": {
                    "addressLine1": "Some address Line 1",
                    "addressLine2": "Some address Line 2",
                    "city": "Some city",
                    "region": "Some region",
                    "postCode": "ABCDEF",
                    "country": "US"
                },
                "bankDetails": {
                    "accountNumber": "987654321",
                    "code": "021000021",
                    "accountType": "checking",
                    "address": {
                        "country": "US"
                    }
                }
            }
        }
    },
    "requestDetails": {
        "originator": {
            "ipAddress": "5.57.72.118"
        }
    },
    "metadata": {
        "someKey": "someValue",
        "someKey2": {
            "someKey3": "someValue3"
        }
    }
}
{
    "walletId": "a:24101731223387:BvR3I1g:1",
    "amount": {
        "value": "5",
        "currency": "USD"
    },
    "paymentReference": "REF123",
    "instruction": {
        "type": "FIAT",
        "beneficiary": {
            "details": {
                "alias": "Some Alias",
                "beneficiaryType": "SELF_OWNED",
                "transferDestination": "INTERNATIONAL",
                "currency": "USD",
                "businessDetails": {
                    "businessName": "Marc Ltd"
                },
                "address": {
                    "addressLine1": "7b Manor Gardens",
                    "addressLine2": "Apt 5",
                    "city": "Hout Bay",
                    "region": "WC",
                    "postCode": "7806",
                    "country": "ZA"
                },
                "bankDetails": {
                    "accountNumber": "FR1420041010050500013M02606",
                    "code": "PSSTFRPPLIL",
                    "bankName": "La Banque Postale",
                    "address": {
                        "addressLine1": "3 RUE PAUL DUEZ",
                        "addressLine2": "Apt 5",
                        "city": "LILLE CEDEX 9",
                        "region": "Western Cape",
                        "postCode": "59900",
                        "country": "FR"
                    },
                    "intermediaryBanks": [
                        {
                            "bankName": "some bank",
                            "code": "PSSTFRPPLIL",
                            "address": {
                                "addressLine1": "3 RUE PAUL DUEZ",
                                "addressLine2": "Apt 5",
                                "city": "LILLE CEDEX 9",
                                "region": "Western Cape",
                                "postCode": "59900",
                                "country": "FR"
                            }
                        }
                    ]
                }
            }
        }
    },
    "requestDetails": {
        "originator": {
            "ipAddress": "5.57.72.118"
        }
    },
    "metadata": {
        "someKey": "someValue",
        "someKey2": {
            "someKey3": "someValue3"
        }
    }
}

Note the following details:

  • walletId: The value expects the walletSlId when using the GET Wallets endpoint.
  • paymentReference: Reference for the payment. For ACH, ACH_SAME_DAY, and Fedwire payouts, this field has a maximum length of 10 characters.
  • paymentMethod: If you request an ACH Same Day payout outside its available window, it will be process as a next-day payout. However, the ACH Same Day fee may still be incurred.
  • metadata: Custom key-value info for the payment. Returned in the status field of the `GET /payment/v1/payouts/transactionReference request. Max 500 characters.

In the successful response, you receive transaction details:

{
    "transactionReference": "1a0c24c7-c578-40ff-92cc-7a56c320db00",
    "fee": {
        "value": 1000.00,
        "currency": "GBP"
    }
}

The above example uses GBP, the response will vary on the currency field for EUR and USD payouts.

In response, you will also receive a POST location header containing the transactionReference .

Other possible statuses include the following:

StatusHTTP Status codeDescription
PENDING201The payout is pending.
400The payout has validation errors.