Payouts

🚧
If you encounter a situation where the PSP not visible on the payout dropdown or not visible when using the API endpoint, please ensure that you have enabled the "Payouts" feature at the credentials section of the Payment Service Provider (PSP) and the payout type. By enabling this option, you will grant the necessary permissions to initiate payouts effectively.

How to initiate a payout

Payout via the BridgerPay dashboard: To initiate a payout, Look for the Menu located at the top left of the screen and navigate to the Payouts section. Click on the Plus sign to create a new payout transaction.
Enter the required fields: Fill in the necessary information for the payout, such as the recipient details, payout amount, and any other relevant data. Make sure to provide accurate and complete information to ensure a successful payout.
Choose a PSP (Payment Service Provider): Select the appropriate PSP from the available options to initiate the payout from. This choice will determine the specific process and requirements for the payout.
Complete PSP-specific information: Once you have chosen the PSP, a new section will appear with the specific information required by that PSP. This may include additional recipient details, account numbers, or any other relevant details. Fill in this information accurately.
Initiate the payout: After entering all the necessary information and verifying its accuracy, click on the "Make a payout" to initiate the payout transaction. Ensure that you have reviewed all details before proceeding.

How to initiate a payout API request

Get authorized as a merchant.
Generate a metadata by using the get payout providers endpoint with the required country and currency.

GET https://api.bridgerpay.com/v2/{api_key}/payouts/metadata?country=BE&currency=EUR
Content-Type: application/json
Authorization: Bearer {{ACCESS_TOKEN}}

Use the create payout endpoint.

POST https://api.bridgerpay.com/v2/{api_key}/payouts
Content-Type: application/json
Authorization: Bearer {{ACCESS_TOKEN}}
{
  "order_id": "a17331a5",
  "provider": "PspName",
  "country": "BE",
  "currency": "EUR",
  "state": null,
  "amount": 1440.00,
  "payout_method_type": "credit_card",
  "metadata":
  {
    "creditCardToken": "",
    "creditCardNumber": "4012888888881881",
    "cardHolderName": "John Smith",
    "expiryMonth": 1,
    "expiryYear": 2022,
    "customerFirstName": "John",
    "customerLastName": "Smith",
    "email": "[email protected]"
  }
}

POST https://api.bridgerpay.com/v2/{api_key}/payouts
Content-Type: application/json
Authorization: Bearer {{ACCESS_TOKEN}}
{
  "order_id": "a17331a4",
  "provider": "PspName",
  "country": "BE",
  "currency": "EUR",
  "state": null,
  "amount": 2723.00,
  "payout_method_type": "bank_account",
  "metadata":
  {
    "bankCode": "AXABBE22",
    "bankName": "AXA Bank Europe",
    "bankBranch": "Bruxelles Trone",
    "bankAddress": "Place du Trone, 1, 1000, Bruxelles, Belgium",
    "bankZipcode": "12345",
    "bankRoutingNumber": "123456789",
    "bankAccountNumber": "12345678901234567890",
    "bankAccountName": "Current account",
    "phone": "+18419998877",
    "customerFirstName": "John",
    "customerLastName": "Smith",
    "email": "[email protected]"
  }
}

POST https://api.bridgerpay.com/v2/{api_key}/payouts
Content-Type: application/json
Authorization: Bearer {{ACCESS_TOKEN}}
{
  "order_id": "a17331a4",
  "provider": "b2_bin_pay_apm",
  "country": "NE",
  "currency": "BTC",
  "state": null,
  "amount": 0.0000000001,
  "payout_method_type": "crypto",
  "metadata":
  {
    "walletAddress": "2NFxxxxxx6oo77vza5fGb3thsUmqt",
    "customerFirstName": "John",
    "customerLastName": "Smith",
    "email": "[email protected]"
  }
}