|
|
The RESTful Payment interface allows an application to charge an amount to an end-user’s account using Diameter, refund amounts to that account, and split charge amounts among multiple end-users. An application can also reserve amounts, reserve additional amounts, charge against the reservation or release the reservation.
In the listings below, bold indicates a required attribute, <> a descriptive comment.
| Note: | An HTML version of this information is at http://host:port/rest/payment/index.html where host and port depend on the Oracle Communications Services Gatekeeper installation. |
Charges an amount directly to an end-user’s account using Diameter
http://host:port/rest/payment/charge-amount
"description": "String", <Text to be used for information and billing>
"amount": "BigDecimal", <The amount to be charged>
"code": "String", <A charging code, from an existing contractual description>
"currency": "String" <A currency identifier as defined in ISO 4217 [9]>
"endUserIdentifier": "URI",<The address of the end-user to be charged>
"referenceCode": "String"<A unique identifier in case of disputes>
Refunds an amount directly to an end-user’s account using Diameter
http://host:port/rest/payment/refund-amount
"description": "String", <Text to be used for information and billing>
"amount": "BigDecimal", <The amount to be refunded>
"code": "String", <A charging code, from an existing contractual description>
"currency": "String" <A currency identifier as defined in ISO 4217 [9]>
"endUserIdentifier": "URI",<The address of the end-user to be refunded to>
"referenceCode": "String"<A unique identifier in case of disputes>
Charges an amount directly to multiple end users concurrently (for example, for charging multiple participants in a conference)
http://host:port/rest/payment/charge-split-amount
"description": "String", <Text to be used for information and billing>
"amount": "BigDecimal", <The amount to be refunded>
"code": "String", <A charging code, from an existing contractual description>
"currency": "String" <A currency identifier as defined in ISO 4217 [9]>
"referenceCode": "String",<A unique identifier in case of disputes>
"splitInfo": [{<How the charge should be split>
"endUserIdentifier": "URI",<The address of the end-user>
"percent": "Integer"<The percentage this end-user should be charged>
Reserves an amount for an account indicated by the end-user identifier.
http://host:port/rest/payment/reserve-amount
"description": "String", <Text to be used for information and billing>
"amount": "BigDecimal", <The amount to be reserved>
"code": "String", <A charging code, from an existing contractual description>
"currency": "String" <A currency identifier as defined in ISO 4217 [9]>
"endUserIdentifier": "URI",<The address of the end-user against whose account the reservation is made>
An identifier for the reservation
Reserves an additional amount against an end-user account
http://host:port/rest/payment/reserve-additional-amount
"description": "String", <Text to be used for information and billing>
"amount": "BigDecimal", <The amount to be reserved>
"code": "String", <A charging code, from an existing contractual description>
"currency": "String" <A currency identifier as defined in ISO 4217 [9]>
"reservationIdentifier": "String"<The result value returned from the initial reservation request>
Charges a previously reserved amount against an end-user account
http://host:port/rest/payment/charge-reservation
"description": "String", <Text to be used for information and billing>
"amount": "BigDecimal", <The amount to be reserved>
"code": "String", <A charging code, from an existing contractual description>
"currency": "String" <A currency identifier as defined in ISO 4217 [9]>
"referenceCode": "String",<A unique identifier in case of disputes>
"reservationIdentifier": "String"<The result value returned from the intial reservation request>
Returns funds left in a reservation to the account against which this reservation was made
http://host:port.rest/payment/release-reservation
{"reservationIdentifier": "String"}
The result value returned from the initial reservation request
The content of possible error messages.
"type":"org.csapi.schema.parlayx.common.v3_1.ServiceException"
"type":"org.csapi.schema.parlayx.common.v3_1.PolicyException"
|