Vendor Payments

Initiate vendor payment

post

Initiate payment for one or more bills. Bills must have pay_date set (422 if null).

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

Vendor payment creation request

idempotency_keystringOptional

Responses

200

OK

application/json

Vendor payment creation results

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post/vendor-payments

POST /vendor-payments HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "idempotency_key": "text",
  "items": [
    {
      "bill_id": "text",
      "payment_method_id": "text",
      "payment_speed": "standard"
    }
  ]
}

{
  "results": [
    {
      "bill_id": "text",
      "success": true
    }
  ]
}

Retry failed vendor payment

post

Retry the last failed funding attempt for a bill

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

bill_idstringRequired

Bill ID

Responses

200

OK

application/json

Vendor payment retry result

bill_idstringOptional

404

Not Found

application/json

409

Conflict

application/json

post/vendor-payments/{bill_id}/retry

POST /vendor-payments/{bill_id}/retry HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "bill_id": "text"
}

Bulk cancel vendor payments

post

Cancel multiple vendor payments in a single request

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

Bulk vendor payment cancellation request

Responses

200

OK

application/json

Bulk vendor payment cancellation results

400

Bad Request

application/json

post/vendor-payments/bulk-cancel

POST /vendor-payments/bulk-cancel HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "items": [
    {
      "bill_id": "text",
      "payment_id": "text"
    }
  ]
}

{
  "results": [
    {
      "bill_id": "text",
      "error_reason": "text",
      "success": true
    }
  ]
}

Cancel vendor payment

post

Cancel a single vendor payment

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

Vendor payment cancellation request

bill_idstringOptional

payment_idstringOptional

Responses

200

OK

application/json

Vendor payment cancellation result

payment_idstringOptional

statusstringOptional

400

Bad Request

application/json

409

Conflict

application/json

post/vendor-payments/cancel

POST /vendor-payments/cancel HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "bill_id": "text",
  "payment_id": "text"
}

{
  "payment_id": "text",
  "status": "text"
}