CreatePayment
Creates a sale, an authorized payment to be captured later, or an order.
Stored Procedure Specific Information
The CreatePayment Stored Procedure requires following columns to execute:
- Intent
- ReturnUrl
- CancelUrl
- PayerPaymentMethod
- Transactions
EXEC CreatePayment @Intent = 'sale', @ReturnUrl = 'https://example.com/return', @CancelUrl = 'https://example.com/cancel', @PayerPaymentMethod = 'paypal', @Transactions = '[\n" +
" {\n" +
" \"amount\": {\n" +
" \"total\": \"30.11\",\n" +
" \"currency\": \"USD\",\n" +
" \"details\": {\n" +
" \"subtotal\": \"30.00\",\n" +
" \"tax\": \"0.07\",\n" +
" \"shipping\": \"0.03\",\n" +
" \"handling_fee\": \"1.00\",\n" +
" \"shipping_discount\": \"-1.00\",\n" +
" \"insurance\": \"0.01\"\n" +
" }\n" +
" },\n" +
" \"description\": \"The payment transaction description.\",\n" +
" \"custom\": \"EBAY_EMS_90048630024435\",\n" +
" \"invoice_number\": \"48787589673\",\n" +
" \"payment_options\": {\n" +
" \"allowed_payment_method\": \"INSTANT_FUNDING_SOURCE\"\n" +
" },\n" +
" \"soft_descriptor\": \"ECHI5786786\",\n" +
" \"item_list\": {\n" +
" \"items\": [\n" +
" {\n" +
" \"name\": \"hat\",\n" +
" \"description\": \"Brown hat.\",\n" +
" \"quantity\": \"5\",\n" +
" \"price\": \"3\",\n" +
" \"tax\": \"0.01\",\n" +
" \"sku\": \"1\",\n" +
" \"currency\": \"USD\"\n" +
" },\n" +
" {\n" +
" \"name\": \"handbag\",\n" +
" \"description\": \"Black handbag.\",\n" +
" \"quantity\": \"1\",\n" +
" \"price\": \"15\",\n" +
" \"tax\": \"0.02\",\n" +
" \"sku\": \"product34\",\n" +
" \"currency\": \"USD\"\n" +
" }\n" +
" ],\n" +
" \"shipping_address\": {\n" +
" \"recipient_name\": \"Brian Robinson\",\n" +
" \"line1\": \"4th Floor\",\n" +
" \"line2\": \"Unit #34\",\n" +
" \"city\": \"San Jose\",\n" +
" \"country_code\": \"US\",\n" +
" \"postal_code\": \"95131\",\n" +
" \"phone\": \"011862212345678\",\n" +
" \"state\": \"CA\"\n" +
" }\n" +
" }\n" +
" }\n" +
" ]'
Input
| Name | Type | Required | Description |
| Intent | String | True | The payment intent: sale,authorize,order |
| Transactions | String | True | A JSON aggregate which contains an array of payment-related transactions. |
| NoteToPayer | String | False | A free-form field that clients can use to send a note to the payer. |
| ReturnUrl | String | True | The URL where the payer is redirected after he or she approves the payment.Required for PayPal account payments. |
| CancelUrl | String | True | The URL where the payer is redirected after he or she cancels the payment.Required for PayPal account payments. |
| PayerPaymentMethod | String | True | The payment method. |
| PayerFundingInstruments | String | False | An array of a single funding instrument for the current payment. Valid only and required for the credit card payment method. |
| PayerInfo | String | False | The payer information. |
| ApplicationContext | String | False | Use the application context resource to customize payment flow experience for your buyers. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful or not. |
| Id | String | The PayPal-generated ID for the payment. |