Get international payments configuration

Get international payments (not USD) configuration that is required for compliance with international payment rules of a vendor country and vendor bank account.

This information is based on vendor country, bill currency, and vendor account type. Use this endpoint for getting information before creating an international vendor. In the response, the required paymentPurpose and regulatoryFields information is retrieved for the vendor.

Note: If you are adding paymentPurpose and regulatoryFields information after creating an international vendor, use GET /v3/vendors/{vendorId}/configuration to get the required configuration for your created vendor.

See Create an international vendor for more information on how to set paymentPurpose and regulatoryFields.

Query Params
string
enum
required

Vendor country name

string
enum
required

Bill currency. Three-letter abbreviation.

See Country information for international payments in the BILL Help Center for more information.

string
enum
required

Vendor account type (BUSINESS or PERSON)

Allowed:
Headers
string | null

API session ID generated with /v3/login

string | null

Developer key generated with your BILL developer account

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json