Billing Platform API
API Reference (1.0)
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND
https://my.billingplatform.com/demogm/rest/2.0/REFUND
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "Id": "string", "PaymentItemId": 0, "RefundType": "string", "Note": "string", "VoidRefundItemId": 0, "Status": "string", "Created": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "VoidedRefundId": 0, "GatewayTransactionId": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "gatewayResponseMessage": "string", "gatewayResponseCode": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND
https://my.billingplatform.com/demogm/rest/2.0/REFUND
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string",
"PaymentItemId": 0,
"RefundType": "string",
"Note": "string",
"VoidRefundItemId": 0,
"Status": "string",
"Created": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"VoidedRefundId": 0,
"GatewayTransactionId": "string",
"VoidFlag": "string",
"AccountingPeriodId": 0,
"gatewayResponseMessage": "string",
"gatewayResponseCode": "string",
"Updated": "string"
}
}'
{ "retrieveResponse": { "Id": "string", "PaymentItemId": 0, "RefundType": "string", "Note": "string", "VoidRefundItemId": 0, "Status": "string", "Created": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "VoidedRefundId": 0, "GatewayTransactionId": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "gatewayResponseMessage": "string", "gatewayResponseCode": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND
https://my.billingplatform.com/demogm/rest/2.0/REFUND
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string",
"PaymentItemId": 0,
"RefundType": "string",
"Note": "string",
"VoidRefundItemId": 0,
"Status": "string",
"Created": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"VoidedRefundId": 0,
"GatewayTransactionId": "string",
"VoidFlag": "string",
"AccountingPeriodId": 0,
"gatewayResponseMessage": "string",
"gatewayResponseCode": "string",
"Updated": "string"
}
}'
{ "retrieveResponse": { "Id": "string", "PaymentItemId": 0, "RefundType": "string", "Note": "string", "VoidRefundItemId": 0, "Status": "string", "Created": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "VoidedRefundId": 0, "GatewayTransactionId": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "gatewayResponseMessage": "string", "gatewayResponseCode": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND
https://my.billingplatform.com/demogm/rest/2.0/REFUND
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "Id": "string", "PaymentItemId": 0, "RefundType": "string", "Note": "string", "VoidRefundItemId": 0, "Status": "string", "Created": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "VoidedRefundId": 0, "GatewayTransactionId": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "gatewayResponseMessage": "string", "gatewayResponseCode": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND
https://my.billingplatform.com/demogm/rest/2.0/REFUND
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string",
"PaymentItemId": 0,
"RefundType": "string",
"Note": "string",
"VoidRefundItemId": 0,
"Status": "string",
"Created": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"VoidedRefundId": 0,
"GatewayTransactionId": "string",
"VoidFlag": "string",
"AccountingPeriodId": 0,
"gatewayResponseMessage": "string",
"gatewayResponseCode": "string",
"Updated": "string"
}
}'
{ "retrieveResponse": { "Id": "string", "PaymentItemId": 0, "RefundType": "string", "Note": "string", "VoidRefundItemId": 0, "Status": "string", "Created": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "VoidedRefundId": 0, "GatewayTransactionId": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "gatewayResponseMessage": "string", "gatewayResponseCode": "string", "Updated": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND
https://my.billingplatform.com/demogm/rest/2.0/REFUND
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/REFUND \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"Id": "string",
"PaymentItemId": 0,
"RefundType": "string",
"Note": "string",
"VoidRefundItemId": 0,
"Status": "string",
"Created": "string",
"CreatedUserId": "string",
"UpdatedUserId": "string",
"VoidedRefundId": 0,
"GatewayTransactionId": "string",
"VoidFlag": "string",
"AccountingPeriodId": 0,
"gatewayResponseMessage": "string",
"gatewayResponseCode": "string",
"Updated": "string"
}
}'
{ "retrieveResponse": { "Id": "string", "PaymentItemId": 0, "RefundType": "string", "Note": "string", "VoidRefundItemId": 0, "Status": "string", "Created": "string", "CreatedUserId": "string", "UpdatedUserId": "string", "VoidedRefundId": 0, "GatewayTransactionId": "string", "VoidFlag": "string", "AccountingPeriodId": 0, "gatewayResponseMessage": "string", "gatewayResponseCode": "string", "Updated": "string" } }