Get payout providers

This method is used to fetch a list of available PSPs that support payout transactions.

Request example

GET /v1/{{API_KEY}}/payouts/metadata?country=BE&currency=EUR
Content-Type: application/json
Host: {{API_URL}}
Authorization: Bearer {{ACCESS_TOKEN}}

get
Get Payout Metadata

<URL>/v1/{{API_KEY}}/payouts/metadata
This method is used to fetch a list of available PSPs that support payout transactions originated in a certain currency in a particular country.
Request
Response
Request
Path Parameters
API_KEY
required
string
Software-level credentials that identify a merchant and ensure secure access to sensitive information; provided by BridgerPay
Headers
Content-Type
optional
string
Data format to present information in the response; only "application/json" is supported
Host
optional
string
Web domain identifier
Authorization
required
string
Authorization mechanism: Bearer {{ACCESS_TOKEN}}
Query Parameters
country
required
string
Country where a PSP operates; designated according to ISO 3166-1 — Country Codes (e.g. "US", "CN", or "BE")
currency
required
string
Currency the PSP supports; designated according to ISO 4217 — Currency Codes (e.g. "USD", "CNY", or "EUR")
Response
200: OK
Successful response; in this example, it contains information on two PSPs: one is for the "bank account" payout method, and the other, for the "credit card"
{
"response": {
"status": "OK", //Response status
"code": 200, //Response code
"message": "OK" //Comment associated with the response
},
"result": {
"providers": [
{
/* Payout method is "bank account" */
"name": "psp_name1", //PSP's code name
"title": "PspName1", //PSP's real name
"payout_method_type": "bank_account", //Payout method
"fields": [ //Fields with information on the payout method of the PSP,
//You are required to specify each of them as the "metadata" body parameter
//when creating a payout transaction (see the following method)
{
"name": "bankCode", //Field's code name
"title": "Bank code", //Field's real name
"control_type": "input", //Data type: "number", "input" for a string, "email", "text_area", or a specific one
"validators": null //Set of masks, wildcards, and other rules to define the format of valid input values
},
{
"name": "bankName",
"title": "Bank name",
"control_type": "input",
"validators": null
},
{
"name": "bankBranch",
"title": "Bank branch",
"control_type": "input",
"validators": null
},
{
"name": "bankAddress",
"title": "Bank address",
"control_type": "input",
"validators": null
},
{
"name": "bankZipcode",
"title": "Bank zipcode",
"control_type": "input",
"validators": null
},
{
"name": "bankRoutingNumber",
"title": "Bank routing number",
"control_type": "input",
"validators": null
},
{
"name": "bankAccountNumber",
"title": "Account Number",
"control_type": "input",
"validators": [ //Set of masks, wildcards, and other rules to define the format of valid input values
{
"name": "regex", //Pattern name: "regex" (Regular Expressions) or "email"
"value": "^([a-z0-9\\-])+$", //String defining a rule according to the chosen pattern
"error_message": "Account number contains restricted symbols"
//Error message shown if the rule is violated
}
]
},
{
"name": "bankAccountName",
"title": "Account name",
"control_type": "input",
"validators": null
},
{
"name": "phone",
"title": "Phone",
"control_type": "input",
"validators": null
},
{
"name": "customerFirstName",
"title": "First name",
"control_type": "input",
"validators": [
{
"name": "regex",
"value": "^([\\D\\-\\.,']*[^0-9]*)+$",
"error message": "First name contains restricted symbols"
}
]
},
{
"name": "customerLastName",
"title": "Last name",
"control_type": "input",
"validators": [
{
"name": "regex",
"value": "^([\\D\\-\\.,']*[^0-9]*)+$",
"error message": "Last name contains restricted symbols"
}
]
},
{
"name": "email",
"title": "Email",
"control_type": "email",
"validators": [
{
"name": "email",
"value": null,
"error_message": "Email is invalid"
}
]
}
]
},
/* Payout method is "credit card" */
{
"name": "psp_name2", //PSP's code name
"title": "PspName2", //PSP's real name
"payout_method_type": "credit_card", //Payout method
"fields": [ //Fields with information on the payout method of the PSP,
//You are required to specify each of them as the "metadata" body parameter
//when creating a payout transaction (see the following method)
{
"name": "creditCardToken",
"title": "Credit card token",
"control_type": "input",
"required": false,
"validators": null
},
{
"name": "creditCardNumber", //Field's code name
"title": "Credit card number", //Field's real name
"control_type": "ccNumber", //Data type: "number", "input" for a string, "email", "text_area", or a specific one like that you see here
"required": false, //Specified if the field is mandatory or not
"validators": [ //Set of masks, wildcards, and other rules to define the format of valid input values
{
"name": "nullDependent",
"value": "CreditCardToken",
"error_message": "Credit card number cant be null if CreditCardToken is empty"
}
]
},
{
"name": "cardHolderName",
"title": "Card holder name",
"control_type": "ccHolder",
"required": false,
"validators": [
{
"name": "nullDependent",
"value": "CreditCardToken",
"error_message": "Card holder name cant be null if CreditCardToken is empty"
}
]
},
{
"name": "expirationMonth",
"title": "Expiration month",
"control_type": "number",
"required": false,
"validators": [
{
"name": "nullDependent",
"value": "CreditCardToken",
"error_message": "Expiry month cant be null if CreditCardToken is empty"
}
]
},
{
"name": "expirationYear",
"title": "Expiration year",
"control_type": "number",
"required": false,
"validators": [
{
"name": "nullDependent",
"value": "CreditCardToken",
"error_message": "Expiry year cant be null if CreditCardToken is empty"
}
]
},
{
"name": "customerFirstName",
"title": "First name",
"control_type": "input",
"required": true,
"validators": [ //Set of masks, wildcards, and other rules to define the format of valid input values
{
"name": "regex", //Pattern name: "regex" (Regular Expressions) or "email"
"value": "^([\\D\\-\\.,']*[^0-9]*)+$",
//String defining a rule according to the chosen pattern
"error_message": "First name contains restricted symbols"
//Error message shown if the rule is violated
}
]
},
{
"name": "customerLastName",
"title": "Last name",
"control_type": "input",
"required": true,
"validators": [
{
"name": "regex",
"value": "^([\\D\\-\\.,']*[^0-9]*)+$",
"error_message": "Last name contains restricted symbols"
}
]
},
{
"name": "email",
"title": "Email",
"control_type": "email",
"required": true,
"validators": [
{
"name": "email",
"value": null,
"error_message": "Email is invalid"
}
]
}
]
}
]
}
}
400: Bad Request
Country or currency or both have not been provided or have incorrect format
{
"response": {
"status": "BadRequest",
"code": 400,
"message": "validation_error"
},
"result": [
{
"type": "validation_error",
"field": "country",
"message": "'Country' must not be empty. Property: Country"
},
{
"type": "validation_error",
"field": "currency",
"message": "Currency is ivalid or empty Property: Currency"
}
]
}
401: Unauthorized
1) Attempt to access the resource without authorization (empty response) 2) No API_KEY or invalid API_KEY provided to access the resource
{
"response": {
"code": 401,
"message": "merchant api key '<API_KEY>' is invalid"
}
}