Managing credit lines

This document describes how Solution Partners can share and revoke lines of credit with onboarded busines customers.

Authentication and authorization

Nearly all credit line related endpoints require your system user acess token. In addition, the system user who the token represents must have granted your app the business_management permission, and must have been granted an Admin or Financial Editor role on your business portfolio.

Get your credit line ID

Nearly all API calls related to credit lines require your credit line ID. Use the GET /<BUSINESS_ID>/extendedcredits endpoint to get your business portfolio's credit line ID.

Request

curl 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PORTFOLIO_ID>/extendedcredits' \
-H 'Authorization: Bearer <SYSTEM_TOKEN>'

Response

Upon success, the API will return the business portfolio's extended credit line ID ("credit line ID").

{
  "data": [
    {
      "id": "<EXTENDED_CREDIT_LINE_ID>"
    }
  ]
}

Sharing your credit line

Use the POST /<EXTENDED_CREDIT_LINE_ID>/whatsapp_credit_sharing_and_attach endpoint to share your credit line with an onboarded business customer.

Request

curl -X POST 'https://graph.facebook.com/<API_VERSION>/<EXTENDED_CREDIT_LINE_ID>/whatsapp_credit_sharing_and_attach?waba_currency=<CUSTOMER_BUSINESS_CURRENCY>&waba_id=<CUSTOMER_WABA_ID>' \
-H 'Authorization: Bearer <SYSTEM_TOKEN>'

Request paramaters

Response

Upon success:

{
  "allocation_config_id": "<ALLOCATION_CONFIGURATION_ID>",
  "waba_id": "<CUSTOMER_WABA_ID>"
}

Response parameters

Alternate method for sharing your credit line

Step 1: Get your customer's business portfolio ID

Use the GET /<WABA_ID> endpoint and request the owner_business_info field to get the business customer's business portfolio ID.

Request

curl --get 'https://graph.facebook.com/v21.0/<WABA_ID>?fields=owner_business_info' \
-H 'Authorization: Bearer <BUSINESS_TOKEN>'

Request paramaters

Response

Upon success:

{
  "owner_business_info": {
    "name": "<BUSINESS_PORTFOLIO_NAME>",
    "id": "<BUSINESS_PORTFOLIO_ID>"
  },
  "id": "<WABA_ID>"
}

Response parameters

Step 2: Share your credit line with the customer's business

Use the POST /<EXTENDED_CREDIT_ID>/whatsapp_credit_sharing endpoint and your system token to indicate your intent to share your credit line with the customer's business portfolio.

Request

curl -X POST 'https://graph.facebook.com/v21.0/<EXTENDED_CREDIT_LINE_ID>/whatsapp_credit_sharing?receiving_business_id=<BUSINESS_PORTFOLIO_ID>' \
-H 'Authorization: Bearer <SYSTEM_TOKEN>'

Request paramaters

Response

Upon success:

{
  "success": true,
  "allocation_config_id": "<ALLOCATION_CONFIG_ID>"
}

Response parameters

Step 3: Attach your credit line to the customer's WABA

Use the POST /<EXTENDED_CREDIT_LINE_ID>/whatsapp_credit_attach endpoint to attach your credit line to the customer's WABA.

Request

curl -X POST 'https://graph.facebook.com/v21.0/<EXTENDED_CREDIT_LINE_ID>/whatsapp_credit_attach?waba_currency=<WABA_CURRENCY>&waba_id=<WABA_ID>' \
-H 'Authorization: Bearer <BUSINESS_TOKEN>'

Request paramaters

Response

Upon success:

{
  "success": true,
  "waba_id": "<WABA_ID>",
  "allocation_config_id": "<ALLOCATION_CONFIG_ID>"
}

Response parameters

Your credit line should now be shared with the business customer. If you want to verify that it has in fact been shared, see Verifying that your credit line has been shared with a customer.

Sharing your credit line via Business Manager

Refer to our Share access to monthly invoicing Help Center article to learn how to share your credit line with an onboarded business customer using the Business Manager.

Verifying shared status

Perform the following queries if you want to make sure that your credit line has been shared with an onboarded business customer.

Step 1: Get credit line's receiving credential

Use the GET /<EXTENDED_CREDIT_ALLOCATION_ID> endpoint to request the receiving_credential field on your extended credit allocation ID (returned when you shared your credit line with the business customer).

Request

curl 'https://graph.facebook.com/<API_VERSION>/<EXTENDED_CREDIT_ALLOCATION_ID>?fields=receiving_credential' \
-H 'Authorization: Bearer <SYSTEM_TOKEN>'

Response

Upon success:

{
  "receiving_credential": {
    "id": "<RECEIVING_CREDENTIAL_ID>" 
  },
  "id": "<ALLOCATION_CONFIGURATION_ID>"
}

Step 2: Get WABA's primary funding ID

Use the GET / endpoint to request the primary_funding_id on the customer's WABA ID.

Request

curl 'https://graph.facebook.com/v21.0/<CUSTOMER_WABA_ID>/?fields=primary_funding_id' \
-H 'Authorization: Bearer <CUSTOMER_BUSINESS_TOKEN>'

Response

Upon success:

{
  "primary_funding_id": "<PRIMARY_FUNDING_ID>",
  "id": "<CUSTOMER_WABA_ID>"
}

Step 3: Compare IDs

Compare the receiving credential ID to the primary funding ID. If the values match, your credit line has been shared correctly with the business customer's WABA.

Revoke a shared credit line

These are the steps needed to remove the shared line of credit if you need to revoke access for any reason. You can revoke your credit line whenever you feel the need to and/or when your client removes you as a partner from their WhatsApp Business Account.

When you revoke a credit line from a customer's account, that revocation applies to all WABAs that belong to the customer's business and have been shared with you, the Solution Partner.

Step 1: Get your credit line ID

curl -i -X GET "https://graph.facebook.com/v21.0/{business-id}/
  extendedcredits?fields=id,legal_entity_name&
  access_token={system-user-access-token}"

{
  "data": [
    {
      "id": "1972385232742146",    
      "legal_entity_name": "Your Legal Entity",
    }
  ]
}

Step 2: Get the customer's business portfolio ID

curl -i -X GET "https://graph.facebook.com/v21.0/
  {whatsapp-business-account-id}?fields=owner_business_info&
  access_token={system-user-access-token}"

{ 
  "owner_business_info": { 
    "name": "Client Business Name", 
    "id": "1972385232742147" 
  }, 
}

Step 3: Get the customer's credit sharing record

  curl -i -X GET "https://graph.facebook.com/v21.0/{extended-credit-id}/
  owning_credit_allocation_configs?
  receiving_business_id={clients-business-id}&
  fields=id,receiving_business&
  access_token={system-user-access-token}"

{
  "id": "1972385232742140", // Allocation config (i.e., credit sharing) id
  "receiving_business": {
    "name": "Client Business Name"
    "id": "1972385232742147"
  },
}

Step 4: Revoke credit sharing

Request:

  curl -i -X DELETE "https://graph.facebook.com/v21.0/
  {allocation-config-id}?
  access_token={system-user-access-token}"

Response:

{
  "success": true,
}

Step 5: Verify credit sharing was revoked (Optional)

Request:

curl -i -X GET "https://graph.facebook.com/v21.0/
  {allocation-config-id}?fields=receiving_business,request_status&
  access_token={system-user-access-token}"

Response:

{
  "receiving_business": {
    "name": "Client Business Name"
    "id": "1972385232742147"
  },
  "request_status": "DELETED"
}

Troubleshooting

Unshared WhatsApp Business Accounts

If the WhatsApp Business Account was unshared with the Solution Partner or the client business removed the Solution Partner as a partner from the WhatsApp Business Account, you are not able to access the client's business ID from the API call listed in Step 2.

In this case, you can retrieve the client's business ID from the email notification that was sent to the Solution Partner business admins when the client business removed the Solution Partner as a partner from the WhatsApp Business Account.

When the WhatsApp Business Account is unshared, all messaging for that account is blocked to protect the Solution Partner's credit line. For complete security, it is recommended that Solution Partners revoke their credit line as soon as the unshare occurs.

See Also

• Reference: Business
• Reference: WhatsApp Business Account
• Reference: Extended Credit