API Reference (1.0)
Billing Platform API
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PAYMENT
https://my.billingplatform.com/demogm/rest/2.0/PAYMENT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PAYMENT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountingPeriodId": null,
"AchBankAcctNum": null,
"AchToken": null,
"Address1": null,
"AllocatedToExtAccount": null,
"ApproveInvoiceId": null,
"Autoallocate": null,
"AutomaticPayment": null,
"BillingProfileId": null,
"BpPayoutId": null,
"CheckNumber": null,
"City": null,
"Country": null,
"Created": null,
"CreatedUserId": null,
"CreditCardCCV": null,
"CreditCardExpDate": null,
"CreditCardName": null,
"CreditCardNumber": null,
"CreditCardToken": null,
"CreditCardTransactionMessage": null,
"CreditCardTransactionStatus": null,
"CreditCardTransactionStatusCode": null,
"CreditCardType": null,
"EcomTransactionId": null,
"EcomTransactionResponseId": null,
"ExternalReferenceId": null,
"GatewayTransactionId": null,
"GatewayTransactionStatus": null,
"GatewayTransactionStatusDate": null,
"HostedPaymentPageExternalId": null,
"Id": null,
"InvoiceIdDisplay": null,
"LateApprovedBy": null,
"LockboxRecordId": null,
"OperatorId": null,
"PaStrategyIds": null,
"PaymentAllocationStrategy": null,
"PaymentCreditAllocationMethod": null,
"PaymentDate": null,
"PaymentGatewayProfileId": null,
"PaymentNote": null,
"PaymentType": null,
"PayoutId": null,
"PendingAmount": null,
"SinglePaymentGroup": null,
"SourcePaymentId": null,
"State": null,
"TaxAllocation": null,
"Updated": null,
"UpdatedUserId": null,
"VoidFlag": null,
"VoidWithoutGateway": null,
"VoidedPaymentId": null,
"WalletId": null,
"Zip": null
}
}'Response
application/json
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PAYMENT
https://my.billingplatform.com/demogm/rest/2.0/PAYMENT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PAYMENT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountingPeriodId": null,
"AchBankAcctNum": null,
"AchToken": null,
"Address1": null,
"AllocatedToExtAccount": null,
"ApproveInvoiceId": null,
"Autoallocate": null,
"AutomaticPayment": null,
"BillingProfileId": null,
"BpPayoutId": null,
"CheckNumber": null,
"City": null,
"Country": null,
"Created": null,
"CreatedUserId": null,
"CreditCardCCV": null,
"CreditCardExpDate": null,
"CreditCardName": null,
"CreditCardNumber": null,
"CreditCardToken": null,
"CreditCardTransactionMessage": null,
"CreditCardTransactionStatus": null,
"CreditCardTransactionStatusCode": null,
"CreditCardType": null,
"EcomTransactionId": null,
"EcomTransactionResponseId": null,
"ExternalReferenceId": null,
"GatewayTransactionId": null,
"GatewayTransactionStatus": null,
"GatewayTransactionStatusDate": null,
"HostedPaymentPageExternalId": null,
"Id": null,
"InvoiceIdDisplay": null,
"LateApprovedBy": null,
"LockboxRecordId": null,
"OperatorId": null,
"PaStrategyIds": null,
"PaymentAllocationStrategy": null,
"PaymentCreditAllocationMethod": null,
"PaymentDate": null,
"PaymentGatewayProfileId": null,
"PaymentNote": null,
"PaymentType": null,
"PayoutId": null,
"PendingAmount": null,
"SinglePaymentGroup": null,
"SourcePaymentId": null,
"State": null,
"TaxAllocation": null,
"Updated": null,
"UpdatedUserId": null,
"VoidFlag": null,
"VoidWithoutGateway": null,
"VoidedPaymentId": null,
"WalletId": null,
"Zip": null
},
"externalIDFieldName": "HostedPaymentPageExternalId"
}'Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/PAYMENT
https://my.billingplatform.com/demogm/rest/2.0/delete/PAYMENT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/PAYMENT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'Response
application/json
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PAYMENT
https://my.billingplatform.com/demogm/rest/2.0/PAYMENT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PAYMENT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountingPeriodId": null,
"AchBankAcctNum": null,
"AchToken": null,
"Address1": null,
"AllocatedToExtAccount": null,
"ApproveInvoiceId": null,
"Autoallocate": null,
"AutomaticPayment": null,
"BillingProfileId": null,
"BpPayoutId": null,
"CheckNumber": null,
"City": null,
"Country": null,
"Created": null,
"CreatedUserId": null,
"CreditCardCCV": null,
"CreditCardExpDate": null,
"CreditCardName": null,
"CreditCardNumber": null,
"CreditCardToken": null,
"CreditCardTransactionMessage": null,
"CreditCardTransactionStatus": null,
"CreditCardTransactionStatusCode": null,
"CreditCardType": null,
"EcomTransactionId": null,
"EcomTransactionResponseId": null,
"ExternalReferenceId": null,
"GatewayTransactionId": null,
"GatewayTransactionStatus": null,
"GatewayTransactionStatusDate": null,
"HostedPaymentPageExternalId": null,
"Id": null,
"InvoiceIdDisplay": null,
"LateApprovedBy": null,
"LockboxRecordId": null,
"OperatorId": null,
"PaStrategyIds": null,
"PaymentAllocationStrategy": null,
"PaymentCreditAllocationMethod": null,
"PaymentDate": null,
"PaymentGatewayProfileId": null,
"PaymentNote": null,
"PaymentType": null,
"PayoutId": null,
"PendingAmount": null,
"SinglePaymentGroup": null,
"SourcePaymentId": null,
"State": null,
"TaxAllocation": null,
"Updated": null,
"UpdatedUserId": null,
"VoidFlag": null,
"VoidWithoutGateway": null,
"VoidedPaymentId": null,
"WalletId": null,
"Zip": null
}
}'Response
application/json
{ "createResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PAYMENT
https://my.billingplatform.com/demogm/rest/2.0/PAYMENT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PATCH \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/PAYMENT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountingPeriodId": null,
"AchBankAcctNum": null,
"AchToken": null,
"Address1": null,
"AllocatedToExtAccount": null,
"ApproveInvoiceId": null,
"Autoallocate": null,
"AutomaticPayment": null,
"BillingProfileId": null,
"BpPayoutId": null,
"CheckNumber": null,
"City": null,
"Country": null,
"Created": null,
"CreatedUserId": null,
"CreditCardCCV": null,
"CreditCardExpDate": null,
"CreditCardName": null,
"CreditCardNumber": null,
"CreditCardToken": null,
"CreditCardTransactionMessage": null,
"CreditCardTransactionStatus": null,
"CreditCardTransactionStatusCode": null,
"CreditCardType": null,
"EcomTransactionId": null,
"EcomTransactionResponseId": null,
"ExternalReferenceId": null,
"GatewayTransactionId": null,
"GatewayTransactionStatus": null,
"GatewayTransactionStatusDate": null,
"HostedPaymentPageExternalId": null,
"Id": null,
"InvoiceIdDisplay": null,
"LateApprovedBy": null,
"LockboxRecordId": null,
"OperatorId": null,
"PaStrategyIds": null,
"PaymentAllocationStrategy": null,
"PaymentCreditAllocationMethod": null,
"PaymentDate": null,
"PaymentGatewayProfileId": null,
"PaymentNote": null,
"PaymentType": null,
"PayoutId": null,
"PendingAmount": null,
"SinglePaymentGroup": null,
"SourcePaymentId": null,
"State": null,
"TaxAllocation": null,
"Updated": null,
"UpdatedUserId": null,
"VoidFlag": null,
"VoidWithoutGateway": null,
"VoidedPaymentId": null,
"WalletId": null,
"Zip": null
},
"externalIDFieldName": "HostedPaymentPageExternalId"
}'Response
application/json
{ "upsertResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/PAYMENT
https://my.billingplatform.com/demogm/rest/2.0/delete/PAYMENT
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X DELETE \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/delete/PAYMENT \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string"
}
}'Response
application/json
{ "updateResponse": [ { … } ] }