- Previous: Create Email Message
- Up: Private Messaging APIs
- Next: Deallocate Child Message
Create Gift Message
The "CreateGift" message is sent from the Global Partner (GP) to the Global Ministry Center (GMC).
The "CreateGift" message is for an existing Constituent to send a gift to their sponsored child, their sponsored child’s family, or make a donation to Compassion for general child gifts and projects.
Once the sent "CreateGift" message has been processed by the GMC, a corresponding "GiftCreated" message will eventually be returned to the GP from the GMC. This is an asynchronous process.
Sample Message
Parameters
Error Messages
Sample Message
This is an example only.
<EsbEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://schemas.ci.org/ci/messaging/common/2011/04/">
<EsbHeader>
<SendersName>[string]</SendersName>
<SendersAppName>[string]</SendersAppName>
<SendersTrackingId>[GUID]</SendersTrackingId>
<ToAddress>[string]</ToAddress>
<FromAddress>[string]</FromAddress>
<MessageType schemaLocation=
"http://schemas.ci.org/ci/messaging/compass/2013/02/CompassMessages.xsd">
http://schemas.ci.org/ci/messaging/compass/2013/02/CreateGift</MessageType>
<RequestId>[string]</RequestId>
</EsbHeader>
<EsbBody>
<CreateGift SchemaVersion ="1.0"
xmlns="http://schemas.ci.org/ci/messaging/compass/2013/02/">
<PartnerCountryCode>AA</PartnerCountryCode>
<ConstituentId>[string]</ConstituentId>
<NeedKey>[string]</NeedKey>
<GiftType>[string]</GiftType>
<GiftAmount>[string]</GiftAmount>
<GiftInstructions>[string]</GiftInstructions>
<TransactionDate>mm-dd-yyyy</TransactionDate>
<SentDate>mm-dd-yyyy</SentDate>
</CreateGift>
</EsbBody>
</EsbEnvelope>
Parameters
Name | Description |
---|---|
EsbEnvelope Headers | |
SendersName | Supplied by Cornerstone Connect during GP setup |
SendersAppName | Supplied by Cornerstone Connect during GP setup |
SendersTrackingId | Supplied by Cornerstone Connect during GP setup |
ToAddress | Supplied by Cornerstone Connect during GP setup |
FromAddress | Supplied by Cornerstone Connect during GP setup |
MessageType | http://schemas.ci.org/ci/messaging/compass/2013/02/CreateGift |
RequestId | Unique number created by GP in order to track specific messages. A message returned from Compass will have the RequestId populated in the RequestCorrelationId. |
EsbBody (used by Compass) | |
CreateGift | |
ConstituentId | |
NeedKey | ChildKey (unless the Gift Type is a ProjectGift, then the NeedKey must be for the Project) |
GiftType |
GiftType can be:
|
GiftAmount | A monetary value in local currency (i.e. partner countries using EUR would send amounts in EUR, etc...) |
GiftInstructions | Any instructions that the giver has for the gift amount |
PartnerCountryCode | IP country code sending the message |
TransactionDate | Date the GP solidified the transaction. This can be the same day or earlier than the SentDate. |
SentDate | Automatically populated when the message is sent |
Possible Error Messages Returned from the Compass Party Host
Error Message Text | Error Message Description |
---|---|
ConstituentId (con_id) is required | |
NeedKey (need_key) is required | |
GiftType (gift_type_id) is required | |
GiftAmount (pc_amt) is required | |
GiftTypeId (gift_type_id) does not exist | |
GiftTypeId ({value}) is not active | |
Invalid NeedKey ({value}) for Child gift type | The NeedKey provided is not a child need (length of 9) |
Invalid NeedKey ({value}) for Project gift type | The NeedKey provided is not a project need (length of 5) |
Gift description/instructions (@descr) are longer than 60 characters | |
je_process_date ({value}) cannot be after current date | The TransactionDate provided cannot be after the current date |
PartnerCountryCode (@partner_country_code) – {value} does not exist | The PartnerCountryCode provided does not exist in the DB |
PartnerCountryCode (@partner_country_code) – {value} is not active | The PartnerCountryCode provided is not active in the DB |
ConstituentId (@con_id): {value} does not exist | The ConstituentId provided does not exist in the DB |
GiftAmount (pc_amt) cannot be zero or negative | The GiftAmount must be greater than zero |
NeedKey + ({value}) does not exist | The NeedKey provided does not exist in the DB |
NeedKey for program + ({value}) does not exist | The program for the NeedKey provided does not exist |
Constituent: ({value}) is not the sponsor of this child: {value} | |
Child has been departed longer than allowed to receive a gift | The NeedKey provided has been departed longer than specified in the DB table |
Invalid CONACT (con_act) for this sponsor ({value}) | The ConstituentId provided has to either be a sponsor or correspondent to this NeedKey when it is a child gift and they must be either CDSP or LDP |
- Previous: Create Email Message
- Up: Private Messaging APIs
- Next: Deallocate Child Message
Docs Navigation
- Compassion API Library
- Standards Documents
- Legacy APIs (Deprecating)
- Web Services Handshake (Legacy) - Notification and Command Messages
- Public API
- Private IPG APIs
- Private REST Services
- REST Get CDSP Implementor V1
- REST Get Child Case Study V1
- REST Get Child Exit Details V1
- REST Get Child Image V1
- REST Get Child Information V1
- REST Get Community V1
- REST Get Country V1
- REST Get CSP Implementor V1
- REST Get Local Church Partner V1
- REST Get Program Implementor V1
- REST Get Project Age Groups V1
- REST Get Child Image V1 - 2015/03
- Private Messaging APIs
- Quick Start Guide
- OffRamp Prerequisites and Setup
- IP OnRamp Service Configuration
- Available Message Types
- Message and Service Relationships
- Troubleshooting
- General Error Messages from Compass Party Host
- EsdMessageErrorMOE Sample
- Sample REST End-To-End Test Plan
- SOAP Wrapper Sample for Messages to GMC
- Allocate Child Message
- Cancel Commitment Message
- Commitment Canceled Message
- Commitment Created Message
- Constituent Created Message
- Constituent Updated Message
- Constituent Upserted Message
- Create Commitment Message
- Create Constituent Message
- Create Email Message
- Create Gift Message
- Deallocate Child Message
- Depart Child Message
- Email Created Message
- Email Updated Message
- Gift Created Message
- Update Child Message
- Update Constituent Message
- Update Email Message
- Upsert Constituent Message
- Update Project Message
- Private SOAP Services
- SOAP Get Child Exit Detail 201211
- SOAP Get Child Exit Detail 201310
- SOAP Get CDSP Implementor 201309
- SOAP Get Child Image 201211
- SOAP Get Child Case Study 201310
- SOAP Get Child Case Study 201412
- SOAP Get Child Information 201211
- SOAP Get Child Information 201310
- SOAP Get Community 201309
- SOAP Get Country Information 201104
- SOAP Get Local Church Partner 201309
- SOAP Get Program Implementor 201303
- SOAP Get Program Implementor 201309
- SOAP Get Project Age Group 201309
- Service Overview
- SOAP Get CSP Implementor 201309
- SOAP Get Child Image 201503
- Private USA APIs
- Private USA Web APIs
- private cornerstone connect messaging
- private cornerstone test
- public api
0 Comments
New comments are not being accepted at this time.