Payment
Learn about how Metaprise powers a range of global payment methods.
Overview
Find a guide to integrate Metaprise's payments APIs. The Payment Methods API allows you to accept a variety of payment methods through a single API.
Supported payment methods
Currency | US Priority | US Regular | GB Priority | GB Regular | HK Priority | HK Regular | SG Priority | SG Regular | CA Priority | CA Regular | EU Priority | EU Regular |
---|---|---|---|---|---|---|---|---|---|---|---|---|
USD | Wire | ACH | Swift | - | Swift | - | Swift | - | Swift | - | Swift | - |
GBP | Swift | - | FPS | BACS | Swift | - | Swift | - | Swift | - | Swift | - |
EUR | Swift | - | Swift | - | Swift | - | Swift | - | Swift | - | - | SEPA |
HKD | Swift | - | Swift | - | Swift | - | Swift | - | Swift | - | Swift | - |
SGD | Swift | - | Swift | - | Swift | - | Swift | - | Swift | - | Swift | - |
CAD | Swift | - | Swift | Swift | - | Swift | - | - | EFT | Swift | - |
Begin You start
- Sign up the Metaprise developer devhub platform to get your unique Client ID and API key.
- Obtain your access token by authenticating to Metaprise using your unique Client ID and API key. You will need the access token to make API calls.
- Set up webhooks to receive notifications on Payment events.
Payment profiles
Customer Profile | Description |
---|---|
Currency | Currency in which payment is made |
Amount | The amount of the payment |
Reference | User-generated reference code. |
Payment Date | Instructed date of payment - on this date, we will attempt to debit funds on the account and submit the payment to the scheme. Defaults to the earliest possible date if not passed as parameter |
Payment Type | Metaprise supports two types of payments: "priority", made using the Swift network; and "regular", made using the local bank network. |
Reason | The reason of the payment |
Create a Payment
Use API to create a new payment.
- The following example shows how to create a new beneficiary with different payment method.
- Example request
{ "currency": "USD", "beneficiary_id":"7fb35c55-976d-4e77-8f9d-7a152c314222", "reference":"DJS12342512312", "payment_type":"priority", "payment_date":"2022-01-31", "reason":"This is payment reason", "amount": "20.00", "unique_request_id": "712345c55-6j6d-41s7-8233-7a152g614222" }
- Example response
{ "id": "dkl7699-6508-421e-b1cf-d4fbe41ed398", "created": 1678043844, "currency": "USD", "amount": "20.00", "beneficiary_id": "7fb35c55-976d-4e77-8f9d-7a152c314222", "reference": "DJS12342512312", "payment_type": "regular", "payment_date": "2022-01-31", "reason": "This is payment reason", "status": "Pending", "unique_request_id": "dkl7629-6508-421e-b2cf-d41be41ed398" }
- Example request
List Payments
Use list all payments API to update existing beneficiary.
Example request
{
"starting_after": "7fb35c55-976d-4e77-8f9d-7a152c314222",
"limit": 20
}
Example rsponse
{
"has_more": "false",
"data": [
{
"id": "dkl7699-6508-421e-b1cf-d4fbe41ed398",
"created":1678043844,
"currency": "USD",
"amount": "20.00",
"beneficiary_id": "7fb35c55-976d-4e77-8f9d-7a152c314222",
"reference": "DJS12342512312",
"payment_type": "regular",
"payment_date": "2022-01-31",
"reason": "This is payment reason",
"status": "Pending"
},
{},
{}
]
}
Updated 9 days ago