Enable payment methods for an entity

Overview

Before an entity can receive or make payments via Monite payment rails, you need to specify the payment methods that the entity will be able to use.

Supported payment methods vary by entity country. See Payment methods for the country coverage.

📘

All API calls mentioned on this page require a partner access token.

Enable payment methods

To enable one or more payment methods for an entity, call PUT /entities/{entity_id}/payment_methods. In the request body, the payment_methods_receive list specifies the methods by which the entity can receive payments from its counterparts, and the payment_methods_send list specifies the methods that the entity can use to make payments to others.

curl -X PUT 'https://api.sandbox.monite.com/v1/entities/3fa85f64...3f66afa6/payment_methods' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN' \
     -H 'Content: application/json' \
     -d '{
       "payment_methods_send": [
         "sepa_credit"
       ],
       "payment_methods_receive": [
         "card",
         "sepa_credit",
         "sepa_debit"
       ],
     }'

📘

Note

Some payment methods can be used both to send and receive payments, while others can be used only to send or only to receive payments. Refer to the Payment method codes table below.

In the response, check the status of each payment method. Those with the active status can be used immediately, whereas inactive methods require additional onboarding of the entity.

{
  "data": [
    {
      "name": "Card payments",
      "type": "card",
      "status": "inactive",
      "direction": "receive"
    },
    {
      "name": "SEPA Payments",
      "type": "sepa_credit",
      "status": "active",
      "direction": "receive"
    },
    {
      "name": "SEPA Payments",
      "type": "sepa_credit",
      "status": "active",
      "direction": "send"
    },
    {
      "name": "SEPA Direct Debit",
      "type": "sepa_debit",
      "status": "active",
      "direction": "receive"
    }
  ]
}

If entity onboarding is required, the next step is to check what additional information the entity needs to provide. The exact onboarding flow depends on the entity country:

• EU and UK entity onboarding:
  • via API
  • via Web Component
• US entity onboarding

Get enabled payment methods

To get the payment methods that were enabled for an entity, call GET /entities/{entity_id}/payment_methods:

curl -X GET 'https://api.sandbox.monite.com/v1/entities/3fa85f64...3f66afa6/payment_methods' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN' 

The response contains the display names and codes of each payment methods, the payment direction (send or receive), and the payment method's status (active or inactive). If a specific payment method is enabled for both the send and receive directions, it is listed twice (once per direction).

{
  "data": [
    {
      "name": "Card payments",
      "type": "card",
      "status": "inactive",
      "direction": "receive"
    },
    ...
    {
      "name": "SEPA Payments",
      "type": "sepa_credit",
      "status": "active",
      "direction": "receive"
    },
    {
      "name": "SEPA Payments",
      "type": "sepa_credit",
      "status": "active",
      "direction": "send"
    },
    {
      "name": "SEPA Direct Debit",
      "type": "sepa_debit",
      "status": "active",
      "direction": "receive"
    }
  ]
}

Payment method codes

The following table contains the payment method codes used by the /entities/{entity_id}/payment_methods endpoints, and whether these methods can be used to send or receive payments.