b2bsoft-ux

(0 reviews)

POST-payment-TMF676

POS Quote Order Payment Confirmation

URL

https://[localhost]:[port]/b2bsoft-ux/v1/{businessId}/payment

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR, CR etc.) identifying the business unit.	Y

name	value	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	N

cURL Request

curl --location 'https://nonprod.esb.cloud.lla.com/dev/b2bsoft-ux/b2bsoft-ux/v1/PR/payment' \
--header 'client_id: abcde' \
--header 'client_secret: 12345' \
--header 'Content-Type: application/json' \
--data-raw '{
    "correlatorId": "B2BSOFTID1234",
    "name": "quotepaymentconfirmationb2bsoft",
    "status": "Done",
    "account": {
        "id": "1234567"
    },
    "paymentMethod": {
        "id": "1",
        "description": "Charge-to-invoice or Pay-now",
        "@type": "voucher"
    },
    "totalAmount": {
        "unit": "USD",
        "value": 123.10
    },
    "@type": "voucher"
}'

Each of the request parameters is detailed.

Name	Type	Description	Required
correlatorId	String	Unique identifier in the client for the payment which is quotePaymentNumber	Y
name	String	Name of the operation being performed	Y
status	string	Payment processed status which will be Done	Y
account	object	Account reference. A account may be a party account or a financial account	Y
account.id	String	Unique identifier of the quote order	Y
paymentMethod	object	Defines a specific method of payment	Y
paymentMethod.id	String	Unique Identifier within the server for the payment method	Y
paymentMethod.description	String	Describes the payment method.	Y
paymentMethod.@type	String	payment categorized Allowed values are : cash (C), digitalWallet, tokenizedCard, bankAccountTransfer (T), bankAccountDebit, bankCard (D / R / S / W), voucher, check (Q), directDebit	Y
totalAmount	object	Amount to be paid	Y
totalAmount.unit	String	Currency (ISO4217 norm uses 3 letters to define the currency)	Y
totalAmount.value	Integer	A positive floating point number	Y
@type	String	payment type like card , cash etc Allowed values are : cash (C), digitalWallet, tokenizedCard, bankAccountTransfer (T), bankAccountDebit, bankCard (D / R / S / W), voucher, check (Q), directDebit	Y

Response

{
    "state": "success"
}

Definitions

Each of the request parameters is detailed.

name	value	description	required
state	string	status of the request	Y

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
    "errors": [
        {
            "code": 400,
            "message": "VALIDATION:BLANK_STRING",
            "description": "correlatorId field is mandatory, cannot be empty"
        }
    ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource."
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The server could not find the requested resource.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method DELETE not allowed for : /{businessId}/payment"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Error",
      "description": "The request failed due to an internal error"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /payment for Business Id: xxxx not implemented"
    }]
  }

Reviews