API references
This section contains standardized reference values, formats, and validation rules used throughout the Getpaid API. Use these information to understand data format requirements, supported values, and constraints when integrating with the Getpaid API.
| Type | Description | Reference |
|---|---|---|
| Country | Countries is referenced by its ISO 3166-1 alpha-2 code in uppercase. For example, DE or US. | ISO 3166-1 alpha-2 country codes |
| Currency | Currencies are specified using the ISO 4217 codes in uppercase. For example, EUR or USD. | ISO 4217 currency codes |
| File MIME type | Supported file formats for document uploads and a correlation between the file format and its MIME type. | Files MIME types |
| Reason code | Getpaid solution resources statuses and be detailed using reason codes. Each resource could contain a different list of reason codes by status with its description and recommended action. See how statuses reasons are described in the API responses. | Resources index |
| Registration number | Company registration number formats support for each country. | Registration numbers |
| Status | Getpaid solution resources, when can change over time, define its own status with a list of descriptive values and transition rules. Some statuses can also define a more detailed reason specifying a reason code. | Resources index |
Resources
Index of status and reason codes of the API resources including them.
| Resource | Statuses | Reason codes |
|---|---|---|
| Checkouts | Checkout statuses | - |
| Payments | Payment statuses | Payment reason codes |
| Refunds | Refund statuses | Refund reason codes |